@sudoplatform/sudo-common 7.0.1 → 7.1.3

package/lib/configurationManager/defaultConfigurationManager.js

@@ -9,15 +9,13 @@ var _Either = require("fp-ts/lib/Either");
 
 var _pipeable = require("fp-ts/lib/pipeable");
 
-var AWS = _interopRequireWildcard(require("aws-sdk"));
+var _s = _interopRequireDefault(require("aws-sdk/clients/s3"));
 
 var _PathReporter = require("io-ts/lib/PathReporter");
 
 var _error = require("../errors/error");
 
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
@@ -91,7 +89,7 @@ class DefaultConfigurationManager {
       };
     }
 
-    const s3Client = new AWS.S3({
+    const s3Client = new _s.default({
       region: region
     });
     const incompatible = [];

package/lib/sudoKeyManager/sudoCryptoProvider.d.ts

@@ -76,14 +76,6 @@ export interface SudoCryptoProvider {
      * @param name The name of the symmetric key.
      */
     doesSymmetricKeyExist(name: string): Promise<boolean>;
-    /**
-     * Checks to see if the specified symmetric key exists.
-     *
-     * @param name The name of the symmetric key.
-     *
-     * @deprecated Use doesSymmetricKeyExist
-     */
-    doesSymmetricKeyExists(name: string): Promise<boolean>;
     /**
      * Deletes a symmetric key from the secure store.
      *
@@ -164,14 +156,6 @@ export interface SudoCryptoProvider {
      * @param name The name of the private key.
      */
     doesPrivateKeyExist(name: string): Promise<boolean>;
-    /**
-     * Checks to see if the specified private key exists.
-     *
-     * @param name The name of the private key.
-     *
-     * @deprecated Use doesPrivateKeyExist
-     */
-    doesPrivateKeyExists(name: string): Promise<boolean>;
     /**
      * Adds a public key to the secure store.
      *

package/lib/sudoKeyManager/sudoKeyManager.d.ts

@@ -57,14 +57,6 @@ export interface SudoKeyManager {
      * @param name The name of the symmetric key.
      */
     doesSymmetricKeyExist(name: string): Promise<boolean>;
-    /**
-     * Checks to see if the specified symmetric key exists.
-     *
-     * @param name The name of the symmetric key.
-     *
-     * @deprecated Use doesSymmetricKeyExist
-     */
-    doesSymmetricKeyExists(name: string): Promise<boolean>;
     /**
      * Deletes a symmetric key from the secure store.
      *
@@ -92,14 +84,6 @@ export interface SudoKeyManager {
      * @param name The name of the private key.
      */
     doesPrivateKeyExist(name: string): Promise<boolean>;
-    /**
-     * Checks to see if the specified private key exists.
-     *
-     * @param name The name of the private key.
-     *
-     * @deprecated Use doesPrivateKeyExist
-     */
-    doesPrivateKeyExists(name: string): Promise<boolean>;
     /**
      * Adds a public key to the secure store.
      *
@@ -332,13 +316,11 @@ export declare class DefaultSudoKeyManager implements SudoKeyManager {
     addSymmetricKey(key: ArrayBuffer, name: string): Promise<void>;
     getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
     doesSymmetricKeyExist(name: string): Promise<boolean>;
-    doesSymmetricKeyExists(name: string): Promise<boolean>;
     deleteSymmetricKey(name: string): Promise<void>;
     generateKeyPair(name: string): Promise<void>;
     addPrivateKey(key: ArrayBuffer, name: string): Promise<void>;
     getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
     doesPrivateKeyExist(name: string): Promise<boolean>;
-    doesPrivateKeyExists(name: string): Promise<boolean>;
     addPublicKey(key: ArrayBuffer, name: string): Promise<void>;
     deletePublicKey(name: string): Promise<void>;
     getPublicKey(name: string): Promise<PublicKey | undefined>;

package/lib/sudoKeyManager/sudoKeyManager.js

@@ -50,11 +50,7 @@ class DefaultSudoKeyManager {
   }
 
   doesSymmetricKeyExist(name) {
-    return this.sudoCryptoProvider.doesSymmetricKeyExists(name);
-  }
-
-  doesSymmetricKeyExists(name) {
-    return this.sudoCryptoProvider.doesSymmetricKeyExists(name);
+    return this.sudoCryptoProvider.doesSymmetricKeyExist(name);
   }
 
   deleteSymmetricKey(name) {
@@ -74,11 +70,7 @@ class DefaultSudoKeyManager {
   }
 
   doesPrivateKeyExist(name) {
-    return this.sudoCryptoProvider.doesPrivateKeyExists(name);
-  }
-
-  doesPrivateKeyExists(name) {
-    return this.sudoCryptoProvider.doesPrivateKeyExists(name);
+    return this.sudoCryptoProvider.doesPrivateKeyExist(name);
   }
 
   addPublicKey(key, name) {

package/lib/utils/base64.d.ts

@@ -2,8 +2,43 @@
  * Utility class for Base64 encoding and decoding.
  */
 export declare class Base64 {
+    private static URLSafeEncodeTransform;
+    private static URLSafeDecodeTransform;
     static decode(encoded: string): ArrayBuffer;
     static encode(buffer: ArrayBuffer): string;
     static decodeString(encoded: string): string;
     static encodeString(string: string): string;
+    /**
+     * Encode a URL safe ArrayBuffer
+     * @param {ArrayBuffer} input buffer to be encoded
+     * @returns {string} encoded string
+     */
+    static urlSafeEncode({ input }: {
+        input: ArrayBuffer;
+    }): string;
+    /**
+     * Decode into a URL safe ArrayBuffer
+     * @param {string} input string to be decoded
+     * @returns {ArrayBuffer} decoded ArrayBuffer
+     */
+    static urlSafeDecode({ encoded }: {
+        encoded: string;
+    }): ArrayBuffer;
+    /**
+     * Encode a URL safe string
+     * @param {string} input string to be encoded
+     * @returns {string} encoded string
+     */
+    static urlSafeEncodeString({ input }: {
+        input: string;
+    }): string;
+    /**
+     * Decode a URL safe string
+     * @param {string} input string to be decoded
+     * @returns {string} decoded string
+     */
+    static urlSafeDecodeString({ encoded }: {
+        encoded: string;
+    }): string;
+    static UrlSafeValidate(encoded: string): boolean;
 }

package/lib/utils/base64.js

@@ -11,6 +11,17 @@ var _buffer = require("./buffer");
  * Utility class for Base64 encoding and decoding.
  */
 class Base64 {
+  static URLSafeEncodeTransform(input) {
+    return input.replace(/\+/g, '-') // Convert '+' to '-'
+    .replace(/\//g, '_') // Convert '/' to '_'
+    .replace(/=+$/, ''); // Remove ending '='
+  }
+
+  static URLSafeDecodeTransform(input) {
+    return input.replace(/\-/g, '+') // Convert '-' to '+'
+    .replace(/\_/g, '/'); // Convert '_' to '/'
+  }
+
   static decode(encoded) {
     return _buffer.Buffer.fromString(atob(encoded));
   }
@@ -26,6 +37,60 @@ class Base64 {
   static encodeString(string) {
     return btoa(string);
   }
+  /**
+   * Encode a URL safe ArrayBuffer
+   * @param {ArrayBuffer} input buffer to be encoded
+   * @returns {string} encoded string
+   */
+
+
+  static urlSafeEncode({
+    input
+  }) {
+    return this.URLSafeEncodeTransform(this.encode(input));
+  }
+  /**
+   * Decode into a URL safe ArrayBuffer
+   * @param {string} input string to be decoded
+   * @returns {ArrayBuffer} decoded ArrayBuffer
+   */
+
+
+  static urlSafeDecode({
+    encoded
+  }) {
+    encoded = this.URLSafeDecodeTransform(encoded);
+    return this.decode(encoded);
+  }
+  /**
+   * Encode a URL safe string
+   * @param {string} input string to be encoded
+   * @returns {string} encoded string
+   */
+
+
+  static urlSafeEncodeString({
+    input
+  }) {
+    return this.URLSafeEncodeTransform(this.encodeString(input));
+  }
+  /**
+   * Decode a URL safe string
+   * @param {string} input string to be decoded
+   * @returns {string} decoded string
+   */
+
+
+  static urlSafeDecodeString({
+    encoded
+  }) {
+    encoded = this.URLSafeDecodeTransform(encoded);
+    return Buffer.from(this.decode(encoded)).toString('utf8');
+  }
+
+  static UrlSafeValidate(encoded) {
+    return /^[A-Za-z0-9\-_]+$/.test(encoded);
+  }
 
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sudoplatform/sudo-common",
-  "version": "7.0.1",
+  "version": "7.1.3",
   "author": "Anonyome Labs, Inc.",
   "repository": {
     "type": "git",
@@ -32,8 +32,7 @@
     "suppress-outdated": "bin/suppress-outdated.sh"
   },
   "files": [
-    "lib",
-    "!*.spec.*"
+    "lib"
   ],
   "resolutions": {
     "**/apollo-cache-inmemory": "^1.6.6",
@@ -77,7 +76,7 @@
     "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
     "ts-mockito": "^2.6.1",
-    "typedoc": "^0.23.8",
+    "typedoc": "^0.23.9",
     "typescript": "^4.7.4"
   },
   "outdatedSuppressions": {

package/.babelrc

@@ -1,10 +0,0 @@
-{
-  "presets": [
-    ["@babel/preset-env", { "targets": { "node": "current" } }],
-    "@babel/preset-typescript"
-  ],
-  "plugins": [
-    "@babel/plugin-proposal-private-methods",
-    "@babel/plugin-proposal-class-properties"
-  ]
-}

package/.eslintrc.js

@@ -1,91 +0,0 @@
-module.exports = {
-  root: true,
-  overrides: [
-    {
-      files: ['*.js'],
-      extends: 'eslint:recommended',
-      parserOptions: { ecmaVersion: 2018 },
-      env: { node: true },
-    },
-    {
-      files: ['**/*.ts'],
-      plugins: ['@typescript-eslint', 'import', 'prettier'],
-      parser: '@typescript-eslint/parser',
-      parserOptions: {
-        project: './tsconfig.test.json'
-      },
-      extends: [
-        'plugin:@typescript-eslint/recommended',
-        'plugin:@typescript-eslint/recommended-requiring-type-checking',
-        'prettier',
-      ],
-      rules: {
-        // Disallow `any`.  (This is overridden for test files, below)
-        '@typescript-eslint/no-explicit-any': 'error',
-
-        // Allow "newspaper" code structure
-        '@typescript-eslint/no-use-before-define': 'off',
-
-        // Allow property definition of prop: string = ""
-        // instead of inferred type such as prop = ""
-        '@typescript-eslint/no-inferrable-types': 'off',
-
-        // Allow TS convention of ignoring args
-        // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-0.html#flag-unused-declarations-with---nounusedparameters-and---nounusedlocals
-        '@typescript-eslint/no-unused-vars': [
-          'error',
-          { argsIgnorePattern: '^_' },
-        ],
-
-        // Soften eslint defaults so that callbacks don't need to be as verbose
-        '@typescript-eslint/explicit-function-return-type': [
-          'error',
-          {
-            allowExpressions: true,
-            allowTypedFunctionExpressions: true,
-          },
-        ],
-
-        // Allow use of unbound static methods
-        '@typescript-eslint/unbound-method': [
-          'error',
-          {
-            'ignoreStatic': true
-          }
-        ]
-      },
-    },
-    {
-      files: ['**/*.d.ts'],
-      rules: {
-        '@typescript-eslint/no-explicit-any': 'off',
-      },
-    },
-    {
-      files: [
-        'test/**/*.ts',
-      ],
-      parser: '@typescript-eslint/parser',
-      parserOptions: {
-        project: './tsconfig.test.json'
-      },
-      extends: [
-        'plugin:@typescript-eslint/recommended',
-        'plugin:@typescript-eslint/recommended-requiring-type-checking',
-        'prettier',
-      ],
-      rules: {
-        '@typescript-eslint/no-namespace': 'off',
-        '@typescript-eslint/no-explicit-any': 'off',
-        '@typescript-eslint/no-non-null-assertion': 'off',
-        '@typescript-eslint/no-unsafe-call': 'off',
-        '@typescript-eslint/no-unsafe-assignment': 'off',
-        '@typescript-eslint/no-unsafe-argument': 'off',
-        '@typescript-eslint/no-unsafe-member-access': 'off',
-        '@typescript-eslint/restrict-plus-operands': 'off',
-        '@typescript-eslint/restrict-template-expressions': 'off',
-        '@typescript-eslint/unbound-method': 'off'
-      },
-    },
-  ],
-}

package/.gitignore

@@ -1,14 +0,0 @@
-.cache
-config
-docs/
-lib
-test-lib
-node_modules
-src/gen
-scratch
-yarn-error.log
-coverage
-.yalc/
-yalc.lock
-config
-package.json.old

package/.gitlab-ci.yml

@@ -1,101 +0,0 @@
-image: '947875592751.dkr.ecr.us-east-1.amazonaws.com/tools/node-build:release'
-
-before_script:
-  - node --version
-  - echo ${DIST_TAG}
-  - echo $(git describe --tags | sed -e 's/^v//')
-
-stages:
-  - Build
-  - Publish
-
-.publish:
-  stage: Publish
-  tags:
-    - docker
-  dependencies:
-    - Build
-
-.publish_internal:
-  extends: .publish
-  script:
-    - env
-      NEXUS_READ_TOKEN="${NEXUS_PUBLISH_TOKEN}"
-      yarn publish --verbose --registry https://repo.tools.anonyome.com/repository/npm-hosted --tag ${DIST_TAG} --new-version $(git describe --tags) --no-git-tag-version --non-interactive
-
-.publish_external:
-  extends: .publish
-  variables:
-    PUB_TAG: $CI_COMMIT_TAG
-    PUB_GITHUB_ACCESS_TOKEN: $GITHUB_ACCESS_TOKEN
-    PUB_GITLAB_ACCESS_TOKEN: $API_ACCESS_TOKEN
-    PUB_DIST_TAG: $DIST_TAG
-    PUB_NODE_AUTH_TOKEN: $NPM_AUTH_TOKEN
-  script:
-    # set credentials to install sdk-publisher from the internal repo, then publish to npm
-    - export NPM_READ_TOKEN="${NEXUS_PUBLISH_TOKEN}"
-    - npx @sudoplatform-private/sdk-publisher@latest --verbose
-
-Build:
-  stage: Build
-  before_script:
-    - npm config set @anonyome:registry https://repo.tools.anonyome.com/repository/npm-hosted
-    - yarn global add @anonyome/dependency-report
-  script:
-    - yarn --frozen-lockfile
-    - yarn build
-    - report-dependencies --outFile ./dependencies-report.json
-  artifacts:
-    paths:
-      - lib/
-      - docs/
-      - dependencies-report.json
-  tags:
-    - docker
-  only:
-    - master
-    - merge_requests
-    - /alpha$/
-    - /beta$/
-    - /^v?\d+\.\d+\.\d+$/
-
-Branch:
-  extends: .publish_internal
-  variables:
-    DIST_TAG: ${CI_COMMIT_REF_SLUG}
-  only:
-    - merge_requests
-  except:
-    - pipelines
-    - triggers
-
-Master:
-  extends: .publish_internal
-  variables:
-    DIST_TAG: master
-  only:
-    - master
-  except:
-    - pipelines
-    - triggers
-
-Alpha:
-  extends: .publish_internal
-  variables:
-    DIST_TAG: alpha
-  only:
-    - /alpha$/
-
-Beta:
-  extends: .publish_external
-  variables:
-    DIST_TAG: beta
-  only:
-    - /beta$/
-
-Release:
-  extends: .publish_external
-  variables:
-    DIST_TAG: latest
-  only:
-    - /^v?\d+\.\d+\.\d+$/

package/.npmignore

@@ -1 +0,0 @@
-CHANGELOG.md

package/.prettierignore

@@ -1,3 +0,0 @@
-lib/
-test-lib/
-coverage/

package/.prettierrc.js

@@ -1,7 +0,0 @@
-module.exports = {
-  "semi": false,
-  "singleQuote": true,
-  "tabWidth": 2,
-  "trailingComma": "all",
-  "useTabs": false
-};

package/.publisher.json

@@ -1,7 +0,0 @@
-{
-  "author": "Sudo Platform Engineering <sudoplatform-engineering@anonyome.com>",
-  "githubProjectName": "sudo-common-js",
-  "githubUsername": "sudoplatform-engineering",
-  "gitlabUrl": "https://gitlab.tools.anonyome.com/api/v4/projects/790/",
-  "internalFiles": [".publisher.json", "CHANGELOG.md", ".gitlab-ci.yml"]
-}

package/.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-  "editor.formatOnSave": true,
-  "typescript.tsdk": "./node_modules/typescript/lib",
-  "eslint.validate": ["typescript"],
-}