1.0.7

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -12,29 +12,38 @@ stages:
   - release
   - metadata
 
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
+
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
+# security stage
+# ====================
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci git mirror
+     - npmci command npm config set registry https://registry.npmjs.org
+     - npmci command pnpm audit --audit-level=high --prod
   tags:
     - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
-snyk:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
     - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -43,28 +52,22 @@ snyk:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
-    - npmci command npm run build
+    - npmci npm build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -84,11 +87,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -108,11 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
+    - npmci node install stable
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -3,10 +3,10 @@
     "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartjimp",
-      "shortDescription": "a tool fr working with images in TypeScript",
-      "npmPackagename": "@pushrocks/smartjimp",
+      "description": "a tool fr working with images in TypeScript",
+      "npmPackagename": "@push.rocks/smartjimp",
       "license": "MIT",
       "projectDomain": "push.rocks"
     }

package.json

@@ -1,24 +1,47 @@
 {
-  "name": "@pushrocks/smartjimp",
-  "version": "1.0.2",
+  "name": "@push.rocks/smartjimp",
+  "version": "1.0.7",
   "private": false,
   "description": "a tool fr working with images in TypeScript",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
-    "format": "(gitzone format)"
+    "build": "(tsbuild --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.7",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0"
+    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsrun": "^1.2.44",
+    "@git.zone/tstest": "^1.0.77",
+    "@push.rocks/tapbundle": "^5.0.8",
+    "@types/node": "^20.10.0"
   },
-  "dependencies": {}
+  "dependencies": {
+    "@push.rocks/levelcache": "^3.0.3",
+    "@push.rocks/smartfile": "^11.0.4",
+    "@push.rocks/smarthash": "^3.0.4",
+    "@push.rocks/smartpath": "^5.0.5",
+    "@push.rocks/smartrequest": "^2.0.15",
+    "@types/sharp": "^0.32.0",
+    "sharp": "^0.32.6"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "type": "module",
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -1,26 +1,37 @@
-# @pushrocks/smartjimp
-a tool for working with images in TypeScript
+# @push.rocks/smartjimp
+a tool fr working with images in TypeScript
 
 ## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartjimp)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartjimp)
 * [gitlab.com (source)](https://gitlab.com/pushrocks/smartjimp)
 * [github.com (source mirror)](https://github.com/pushrocks/smartjimp)
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartjimp/)
 
 ## Status for master
-[![pipeline status](https://gitlab.com/pushrocks/smartjimp/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartjimp/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartjimp/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartjimp/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartjimp.svg)](https://www.npmjs.com/package/@pushrocks/smartjimp)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartjimp/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartjimp)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartjimp/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartjimp/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartjimp)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartjimp)](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/smartjimp)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartjimp)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartjimp)](https://lossless.cloud)
 
 ## Usage
+
 Use TypeScript for best in class intellisense
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+## 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)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,8 +1,18 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartjimp from '../ts/index'
+import { expect, tap } from '@push.rocks/tapbundle';
+import * as smartjimp from '../ts/index.js';
+import * as smartfile from '@push.rocks/smartfile';
+
+let testSmartJimp: smartjimp.SmartJimp;
 
 tap.test('first test', async () => {
-  console.log(smartjimp.standardExport)
-})
+  testSmartJimp = new smartjimp.SmartJimp();
+  expect(testSmartJimp).toBeInstanceOf(smartjimp.SmartJimp);
+});
 
-tap.start()
+tap.test('should be able to create a master', async () => {
+  const smartfileInstance = await smartfile.SmartFile.fromUrl('https://images.unsplash.com/photo-1673276628202-737bf3020ac2?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=3774&q=80')
+  const convertedAsset = await testSmartJimp.getFromSmartfile(smartfileInstance, {width: 500});
+  (await smartfile.SmartFile.fromBuffer('.nogit/result.avif', convertedAsset)).write();
+});
+
+tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartjimp',
+  version: '1.0.7',
+  description: 'a tool fr working with images in TypeScript'
+}

ts/index.ts

@@ -1,3 +1 @@
-import * as plugins from './smartjimp.plugins';
-
-export let standardExport = 'Hi there! :) This is an exported string';
+export * from './smartjimp.classes.smartjimp.js';

ts/smartjimp.classes.smartjimp.ts

@@ -0,0 +1,64 @@
+import * as plugins from './smartjimp.plugins.js';
+
+export interface IDimensions {
+  width?: number;
+  height?: number;
+}
+
+export class SmartJimp {
+  public levelCache = new plugins.levelcache.LevelCache({
+    cacheId: 'mastercache',
+    maxMemoryStorageInMB: 100,
+    maxDiskStorageInMB: 5000, 
+  });
+
+  /**
+   * get a key that is unique for a wanted asset variation
+   */
+  private getCacheKey(
+    sourceTypeArg: 'streamfile' | 'smartfile',
+    sourceIdArg: string,
+    wantedDimensionsArg?: IDimensions
+  ) {
+    return `${sourceTypeArg}_${sourceIdArg}_${
+      wantedDimensionsArg
+        ? `${wantedDimensionsArg.width || 'auto' }x${wantedDimensionsArg.height || 'auto'}`
+        : 'original'
+    }`;
+  }
+
+  private async computeAssetVariation(assetBuffer: Buffer, wantedDimensions?: IDimensions) {
+    if (!wantedDimensions) {
+      return assetBuffer;
+    }
+    let sharpImage = plugins.sharp(assetBuffer);
+    sharpImage = sharpImage.resize(wantedDimensions.width, wantedDimensions.height);
+    const result = await sharpImage.resize(wantedDimensions.width, wantedDimensions.height).avif().toBuffer();
+    return result;
+  }
+
+  public async getFromSmartfile(
+    smartfileArg: plugins.smartfile.SmartFile,
+    wantedDimensionsArg?: IDimensions
+  ) {
+    const cacheKey = this.getCacheKey('smartfile', await smartfileArg.getHash(), wantedDimensionsArg);
+    const existingCacheEntry = await this.levelCache.retrieveCacheEntryByKey(cacheKey);
+    if (existingCacheEntry) {
+      return existingCacheEntry.contents;
+    } else {
+      const computedAssetBuffer = await this.computeAssetVariation(smartfileArg.contentBuffer, wantedDimensionsArg);
+      this.levelCache.storeCacheEntryByKey(cacheKey, new plugins.levelcache.CacheEntry({
+        contents: computedAssetBuffer,
+        ttl: 600000
+      }));
+      return computedAssetBuffer;
+    }
+  }
+
+  public async createAvifImageFromBuffer(bufferArg: Buffer) {
+    const sharpImage = plugins.sharp(bufferArg);
+    const result = await sharpImage.avif().toBuffer();
+    return result;
+  }
+
+}

ts/smartjimp.paths.ts

@@ -0,0 +1,4 @@
+import * as plugins from './smartjimp.plugins.js';
+
+export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');
+export const nogitDir = plugins.path.join(packageDir, '.nogit/')

ts/smartjimp.plugins.ts

@@ -1,4 +1,18 @@
-const removeme = {};
-export {
-  removeme
-}
+// node native
+import * as path from 'path';
+
+export { path };
+
+// @pushrocks scope
+import * as levelcache from '@push.rocks/levelcache';
+import * as smartfile from '@push.rocks/smartfile';
+import * as smarthash from '@push.rocks/smarthash';
+import * as smartpath from '@push.rocks/smartpath';
+import * as smartrequest from '@push.rocks/smartrequest';
+
+export { levelcache, smartpath, smarthash, smartfile, smartrequest };
+
+// third party scope
+import sharp from 'sharp';
+
+export { sharp };

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"
+  ]
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}