@or-sdk/identifiers 0.27.11-beta.4276.0 → 0.27.11-beta.4281.0

package/README.md

@@ -1,23 +1,9 @@
-# `@or-sdk/identifiers`
-
-OneReach SDK client for Identifiers.
-
-## When to use
-
-- Use this package when integrating with the Identifiers capability on the OneReach platform.
-- Use its typed client and exported models instead of hand-writing requests to that service.
-
-## When not to use
-
-- Do not use it for a different platform capability; choose the dedicated `@or-sdk/*` package instead.
-- Do not use it for generic third-party HTTP calls.
-
-## Installation
+## Installation:
 ```
 $ npm i @or-sdk/identifiers
 ```
 
-## Usage
+## Usage:
 ```typescript
 import { Identifiers } from '@or-sdk/identifiers'
 
@@ -33,45 +19,3 @@ const identifiers = new Identifiers({
   discoveryUrl: 'http://example.discovery/endpoint'
 });
  ```
-
-## Configuration
-
-- Prefer `sdkUrl` when the service URL is known; it avoids a discovery request.
-- Use `discoveryUrl` only when the service URL is not available.
-- Provide `token` as a bearer-token string or getter where supported.
-
-## Common pitfalls
-
-- Keep the client token current when it can expire; a token getter is preferable where the constructor accepts one.
-- Treat the generated TypeScript types as the authoritative contract for optional parameters and response shapes.
-
-## Method map
-
-| Method | Purpose |
-|---|---|
-| `init(...)` | See the exported TypeScript signature for parameters and result. |
-| `listIdentifiers(...)` | See the exported TypeScript signature for parameters and result. |
-| `listIdentifierGroups(...)` | See the exported TypeScript signature for parameters and result. |
-| `getIdentifier(...)` | See the exported TypeScript signature for parameters and result. |
-| `getIdentifierGroup(...)` | See the exported TypeScript signature for parameters and result. |
-| `listObtainableIdentifiers(...)` | See the exported TypeScript signature for parameters and result. |
-| `releaseIdentifier(...)` | See the exported TypeScript signature for parameters and result. |
-| `buyIdentifier(...)` | See the exported TypeScript signature for parameters and result. |
-| `createProvider(...)` | See the exported TypeScript signature for parameters and result. |
-| `listProviders(...)` | See the exported TypeScript signature for parameters and result. |
-| `deleteProvider(...)` | See the exported TypeScript signature for parameters and result. |
-
-## More detail
-
-Full signatures and exported types are available in `src/` and `dist/types/`.
-
-
-## Additional API reference
-
-Methods below were missing from the package guide. Signatures and return types are taken directly from the exported source API.
-
-### `Identifiers`
-
-| Method | Returns | Purpose |
-|---|---|---|
-| `listIdentifiersTriggers(identifiers: List<SingleIdentifier>)` | `Promise<List<IdentifierTrigger>>` | Load list of identifier gateway triggers by identifier list. |

package/package.json

@@ -1,17 +1,10 @@
 {
   "name": "@or-sdk/identifiers",
-  "version": "0.27.11-beta.4276.0",
-  "description": "OneReach SDK client for Identifiers",
+  "version": "0.27.11-beta.4281.0",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
-  "files": [
-    "dist",
-    "src",
-    "README.md",
-    "CHANGELOG.md"
-  ],
   "scripts": {
     "build": "pnpm clean && concurrently 'pnpm:build:*(!watch)'",
     "build:cjs": "tsc --project tsconfig.json",
@@ -29,7 +22,7 @@
   },
   "dependencies": {
     "@or-sdk/base": "^0.44.7",
-    "@or-sdk/sdk-api": "^0.29.6-beta.4276.0"
+    "@or-sdk/sdk-api": "^0.29.6-beta.4281.0"
   },
   "devDependencies": {
     "concurrently": "9.0.1",

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src"
+  },
+  "exclude": [
+    "./src/__tests__"
+  ]
+}

package/tsconfig.dev.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.esm.json",
+  "compilerOptions": {
+    "declarationDir": "./dist/types",
+    "declaration": true
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.build.json",
+  "compilerOptions": {
+    "outDir": "./dist/esm",
+    "declarationDir": "./dist/types",
+    "module": "ES6",
+    "target": "es6",
+    "declaration": true,
+    "declarationMap": true
+  }
+}

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.build.json",
+  "compilerOptions": {
+    "outDir": "./dist/cjs"
+  }
+}

package/tsconfig.types.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.build.json",
+  "compilerOptions": {
+    "outDir": "./dist/types",
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "removeComments": false
+  }
+}

package/vitest.config.mjs

@@ -0,0 +1,25 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    reporters: ['junit', 'default'],
+    outputFile: 'test-results/junit.xml',
+    include: ['src/**/*.{test,spec}.ts'],
+    exclude: ['dist/**'],
+    coverage: {
+      reporter: ['text', 'json', 'html', 'cobertura', 'text-summary'],
+      clean: true,
+      include: [
+        'src/**',
+      ],
+      exclude: [
+        'src/types.ts',
+        '**/*.spec.ts',
+      ],
+    },
+    globals: true,
+    environment: 'node',
+    clearMocks: true,
+    watch: false,
+  },
+});