fix(core): update

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

@@ -0,0 +1,20 @@
+.nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -0,0 +1,21 @@
+{
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
+      "gitrepo": "smartexpose",
+      "description": "a package to expose things to the internet",
+      "npmPackagename": "@push.rocks/smartexpose",
+      "license": "MIT",
+      "projectDomain": "push.rocks"
+    }
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
+  }
+}

package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@push.rocks/smartexpose",
+  "version": "1.0.1",
+  "private": false,
+  "description": "a package to expose things to the internet",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
+  "author": "Task Venture Capital GmbH",
+  "license": "MIT",
+  "scripts": {
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "(tsdoc)"
+  },
+  "devDependencies": {
+    "@git.zone/tsbuild": "^2.1.25",
+    "@git.zone/tsbundle": "^2.0.5",
+    "@git.zone/tsrun": "^1.2.46",
+    "@git.zone/tstest": "^1.0.44",
+    "@push.rocks/qenv": "^6.0.5",
+    "@push.rocks/tapbundle": "^5.0.15",
+    "@types/node": "^20.8.7"
+  },
+  "dependencies": {
+    "@push.rocks/smartfile": "^11.0.14",
+    "@push.rocks/smartjson": "^5.0.19",
+    "@push.rocks/smartwebdav": "^1.0.4",
+    "@push.rocks/taskbuffer": "^3.1.7"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://code.foss.global/push.rocks/smartexpose.git"
+  },
+  "bugs": {
+    "url": "https://code.foss.global/push.rocks/smartexpose/issues"
+  },
+  "homepage": "https://code.foss.global/push.rocks/smartexpose#readme",
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
+}

qenv.yml

@@ -0,0 +1,5 @@
+required:
+  - WEBDAV_SERVER_URL
+  - WEBDAV_SERVER_TOKEN
+  - WEBDAV_SUB_PATH
+  - WEBDAV_EXPOSED_BASE_URL

readme.md

@@ -0,0 +1,31 @@
+# @push.rocks/smartexpose
+a package to expose things to the internet
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartexpose)
+* [gitlab.com (source)](https://code.foss.global/push.rocks/smartexpose)
+* [github.com (source mirror)](https://github.com/push.rocks/smartexpose)
+* [docs (typedoc)](https://push.rocks.gitlab.io/smartexpose/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://code.foss.global/push.rocks/smartexpose/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://code.foss.global/push.rocks/smartexpose/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartexpose)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/smartexpose)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartexpose)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartexpose)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartexpose)](https://lossless.cloud)
+
+## Usage
+Use TypeScript for best in class intellisense
+For further information read the linked docs at the top of this readme.
+
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

test/test.ts

@@ -0,0 +1,24 @@
+import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
+import * as qenv from '@push.rocks/qenv';
+const testQenv = new qenv.Qenv('./', './.nogit/');
+
+import * as smartexpose from '../ts/index.js'
+
+let testSmartexpose: smartexpose.SmartExpose;
+
+tap.test('should create a valid instance of smartexpose using Webdav', async () => {
+  testSmartexpose = await smartexpose.SmartExpose.createWithWebdav({
+    webdavCredentials: {
+      serverUrl: await testQenv.getEnvVarOnDemand('WEBDAV_SERVER_URL'),
+      password: await testQenv.getEnvVarOnDemand('WEBDAV_PASSWORD'),
+    },
+    exposedBaseUrl: await testQenv.getEnvVarOnDemand('WEBDAV_EXPOSED_BASE_URL'),
+    webdavSubPath: await testQenv.getEnvVarOnDemand('WEBDAV_SUB_PATH'),
+    exposeOptions: {
+      deleteAfterMillis: 30000,
+      privateUrl: true,
+    }
+  })
+}
+
+tap.start()

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartexpose',
+  version: '1.0.2',
+  description: 'a package to expose things to the internet'
+}

ts/classes.exposeprovider.ts

@@ -0,0 +1,43 @@
+import * as plugins from './plugins.js';
+
+/**
+ * An expose provider provides a standardized interface for exposing data
+ * Note: SmartExpose comes with some default implmentations of ExposeProvider
+ * 
+ * notably:
+ *   - WebDavExposeProvider
+ */
+export abstract class ExposeProvider {
+
+  /**
+   * Should take care of any housekeeping required to keep things in a healthy state.
+   */
+  public abstract houseKeeping(): Promise<void>;
+  
+  /**
+   * should return a url with info about how to access the file
+   * @param optionsArg 
+   */
+  public abstract exposeFile(optionsArg: {
+    smartFile: plugins.smartfile.SmartFile,
+    deleteAfterMillis?: number,
+    privateUrl?: boolean, // wether the returned url should be private by design
+  }): Promise<{
+    url: string;
+    id: string;
+    status: 'created' | 'updated';
+  }>;
+
+  public abstract start(): Promise<void>;
+
+  public abstract stop(): Promise<void>;
+
+  public abstract wipeAll(): Promise<{
+    id: string;
+    status: 'deleted' | 'failed' | 'notfound';
+  }[]>
+  public abstract wipeFileById(idArg: string): Promise<{
+    id: string;
+    status: 'deleted' | 'failed' | 'notfound';
+  }>
+}

ts/classes.exposeprovider.webdav.ts

@@ -0,0 +1,54 @@
+import { ExposeProvider } from './classes.exposeprovider.js';
+import * as plugins from './plugins.js';
+
+export interface IWebdavExposeProviderOptions {
+  webdavCredentials: plugins.smartwebdav.IWebdavClientOptions,
+  webdavSubPath: string,
+}
+
+export class WebDavExposeProvider extends ExposeProvider {
+  public webdavClient: plugins.smartwebdav.WebdavClient;
+  public options: IWebdavExposeProviderOptions;
+
+  constructor(optionsArg: IWebdavExposeProviderOptions) {
+    super();
+    this.options = optionsArg;
+  }
+
+  public async houseKeeping (): Promise<void> {
+    const directoryContents = await this.webdavClient.listDirectory(this.options.webdavSubPath);
+    for (const fileStat of directoryContents) {
+      // lets read the meta.json file
+      if (fileStat.filename.endsWith('.json')) {
+
+      }
+    }
+  }
+
+  public async ensureBaseDir (): Promise<void> {
+    await this.webdavClient.ensureDirectory(this.options.webdavSubPath);
+  }
+
+  public async start (): Promise<void> {
+    this.webdavClient = new plugins.smartwebdav.WebdavClient(this.options.webdavCredentials);
+    await this.ensureBaseDir();
+    await this.houseKeeping();
+  }
+
+  public async stop (): Promise<void> {
+    // Nothing to do here
+  }
+
+  public async exposeFile (optionsArg: { smartFile: plugins.smartfile.SmartFile; deleteAfterMillis?: number; privateUrl?: boolean; }): Promise<{ url: string; id: string; status: 'created' | 'updated'; }> {
+    await this.ensureBaseDir();
+
+  }
+
+  public async wipeAll (): Promise<{ id: string; status: 'deleted' | 'failed' | 'notfound'; }[]> {
+    
+  }
+
+  public async wipeFileById (idArg: string): Promise<{ id: string; status: 'deleted' | 'failed' | 'notfound'; }> {
+    
+  }
+}

ts/classes.smartexpose.ts

@@ -0,0 +1,33 @@
+import type { ExposeProvider } from './classes.exposeprovider.js';
+import { WebDavExposeProvider } from './classes.exposeprovider.webdav.js';
+import * as plugins from './plugins.js';
+
+export interface ISmartExposeOptions {
+  deleteAfterMillis?: number,
+  privateUrl?: boolean,
+}
+
+export class SmartExpose {
+  // STATIC
+  public static createWithWebdav(optionsArg: {
+    webdavCredentials: plugins.smartwebdav.IWebdavClientOptions,
+    webdavSubPath: string,
+    exposedBaseUrl: string,
+    exposeOptions: ISmartExposeOptions,
+  }) {
+    const provider = new WebDavExposeProvider({
+      webdavCredentials: optionsArg.webdavCredentials,
+      webdavSubPath: optionsArg.webdavSubPath,
+    });
+    const smartexposeInstance = new SmartExpose(provider, optionsArg.exposeOptions);
+    return smartexposeInstance;
+  }
+
+  // INSTANCE
+  public taskmanager: plugins.taskbuffer.TaskManager;
+  public options: ISmartExposeOptions;
+
+  constructor(provider: ExposeProvider, optionsArg: ISmartExposeOptions) {
+    this.options = optionsArg;
+  }
+}

ts/index.ts

@@ -0,0 +1,2 @@
+export * from './classes.exposeprovider.js';
+export * from './classes.smartexpose.js';

ts/plugins.ts

@@ -0,0 +1,12 @@
+// @push.rocks scope
+import * as smartfile from '@push.rocks/smartfile';
+import * as smartjson from '@push.rocks/smartjson';
+import * as smartwebdav from '@push.rocks/smartwebdav';
+import * as taskbuffer from '@push.rocks/taskbuffer';
+
+export {
+  smartfile,
+  smartjson,
+  smartwebdav,
+  taskbuffer,
+}

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}