@deployport/api-services-corelib 0.1.3 → 0.2.0

package/.github/workflows/npm.yaml

@@ -0,0 +1,21 @@
+name: Publish Package to NPM
+on:
+  release:
+    types: [published]
+permissions:
+  contents: read
+  id-token: write # required for npm trusted publishing (OIDC)
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-node@v6
+        with:
+          node-version: "24"
+          registry-url: "https://registry.npmjs.org"
+          package-manager-cache: false # never use caching in release builds
+      # Trusted publishing requires npm 11.5.1 or later
+      - run: npm install -g npm@latest
+      - run: npm install
+      - run: npm publish

package/package.json

@@ -1,13 +1,29 @@
 {
     "name": "@deployport/api-services-corelib",
-    "version": "0.1.3",
+    "version": "0.2.0",
     "description": "",
     "main": "./specular.js",
     "types": "./specular.d.ts",
+    "exports": {
+        ".": {
+            "types": "./specular.d.ts",
+            "default": "./specular.js"
+        },
+        "./configurator": {
+            "types": "./configurator/index.d.ts",
+            "default": "./configurator/index.js"
+        }
+    },
     "author": "bithavoc",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/deployport/api-services-corelib-js.git"
+    },
     "scripts": {
         "prepublishOnly": "npm run build-configurator",
-        "build-configurator": "tsc configurator/index.ts --declaration --module nodenext",
+        "generate": "specular-standalone-compiler generate",
+        "build-configurator": "tsc",
+        "build": "npm run build-configurator",
         "clean": "rm -rf node_modules && rm -f **/*.js **/*.d.ts"
     },
     "type": "module",
@@ -15,10 +31,11 @@
     "dependencies": {
         "@aws-crypto/sha256-js": "^5.2.0",
         "@aws-sdk/types": "^3.515.0",
-        "@deployport/specular-runtime": "^0.1.5"
+        "@deployport/specular-runtime": "^0.2.1"
     },
     "devDependencies": {
-        "@tsconfig/node18": "^18.2.2",
-        "@types/node": "^20.8.3"
+        "@tsconfig/node24": "^24.0.4",
+        "@types/node": "^24.13.2",
+        "typescript": "^6.0.3"
     }
 }

package/specular.d.ts

@@ -1,23 +1,114 @@
 import { Runtime, Metadata } from '@deployport/specular-runtime';
+/** Marks an operation with digital signature authentication for id4ntity verification
+*/
 export declare class SignedOperationV1 {
 }
+/** entity ServiceSignatureV1
+*/
 export declare class ServiceSignatureV1 {
+    /** serviceName parameter
+*/
     ServiceName: string;
 }
+/** Struct metadata
+*/
 export declare const AccessDeniedProblemMeta: Metadata.Struct;
+/** struct AccessDeniedProblem
+*/
 export interface AccessDeniedProblemProperties {
+    /** message property
+*/
     message: string;
 }
-export interface AccessDeniedProblem extends AccessDeniedProblemProperties, Runtime.StructInterface {
-}
-export declare class AccessDeniedProblem extends Error {
+/** struct AccessDeniedProblem
+*/
+export declare class AccessDeniedProblem extends Runtime.RpcError implements AccessDeniedProblemProperties, Runtime.StructInterface {
+    get __structPath(): Metadata.StructPath;
 }
+/** Struct metadata
+*/
 export declare const ForbiddenProblemMeta: Metadata.Struct;
+/** struct ForbiddenProblem
+*/
 export interface ForbiddenProblemProperties {
+    /** message property
+*/
+    message: string;
+}
+/** struct ForbiddenProblem
+*/
+export declare class ForbiddenProblem extends Runtime.RpcError implements ForbiddenProblemProperties, Runtime.StructInterface {
+    get __structPath(): Metadata.StructPath;
+}
+/** Struct metadata
+*/
+export declare const ProblemActionMeta: Metadata.Struct;
+/** A localized call-to-action surfaced alongside a problem. Title and URL
+* are already resolved to a specific locale; clients render them as-is.
+*/
+export interface ProblemActionProperties {
+    /** Optional stable identifier. Clients can key on it to apply custom
+* presentation (icon, ordering) per well-known action.
+*/
+    id: string;
+    /** BCP 47 tag of the locale the title and url were resolved to. May
+* differ from the caller's requested locale when a fallback was used.
+*/
+    locale: string | null;
+    /** title property
+*/
+    title: string;
+    /** url property
+*/
+    url: string | null;
+}
+/** A localized call-to-action surfaced alongside a problem. Title and URL
+* are already resolved to a specific locale; clients render them as-is.
+*/
+export interface ProblemAction extends ProblemActionProperties, Runtime.StructInterface {
+}
+/** Struct metadata
+*/
+export declare const ThrottledProblemMeta: Metadata.Struct;
+/** Raised when the caller is being throttled and should retry later.
+*/
+export interface ThrottledProblemProperties {
+    /** Optional calls-to-action to help the caller (e.g. support, upgrade,
+* docs links), ordered most-specific first. Empty when none apply.
+*/
+    actions: (ProblemActionProperties)[];
+    /** message property
+*/
     message: string;
+    /** Milliseconds the caller should wait before retrying.
+*/
+    retryAfterMs: number | null;
 }
-export interface ForbiddenProblem extends ForbiddenProblemProperties, Runtime.StructInterface {
+/** Raised when the caller is being throttled and should retry later.
+*/
+export declare class ThrottledProblem extends Runtime.RpcError implements ThrottledProblemProperties, Runtime.StructInterface {
+    actions: (ProblemActionProperties)[];
+    retryAfterMs: number | null;
+    get __structPath(): Metadata.StructPath;
+}
+/** Struct metadata
+*/
+export declare const QuotaExceededProblemMeta: Metadata.Struct;
+/** Raised when a resource quota has been exceeded.
+*/
+export interface QuotaExceededProblemProperties {
+    /** Optional calls-to-action to help the caller (e.g. request an increase,
+* upgrade, docs links), ordered most-specific first. Empty when none apply.
+*/
+    actions: (ProblemActionProperties)[];
+    /** message property
+*/
+    message: string;
 }
-export declare class ForbiddenProblem extends Error {
+/** Raised when a resource quota has been exceeded.
+*/
+export declare class QuotaExceededProblem extends Runtime.RpcError implements QuotaExceededProblemProperties, Runtime.StructInterface {
+    actions: (ProblemActionProperties)[];
+    get __structPath(): Metadata.StructPath;
 }
 export declare function SpecularPackage(): Metadata.Package;

package/specular.js

@@ -1,36 +1,129 @@
-// JS gen package
-import { Metadata, } from '@deployport/specular-runtime';
-// SignedOperationV1 entity
-// Marks an operation with digital signature authentication for id4ntity verification
+import { Runtime, Metadata, } from '@deployport/specular-runtime';
+/** Marks an operation with digital signature authentication for id4ntity verification
+*/
 export class SignedOperationV1 {
 }
-// ServiceSignatureV1 entity
+/** entity ServiceSignatureV1
+*/
 export class ServiceSignatureV1 {
+    /** serviceName parameter
+*/
     ServiceName = '';
 }
-const _pkg = new Metadata.Package('Deployport/CoreLib');
+const _pkg = new Metadata.Package("deployport", "corelib");
+/** Struct metadata
+*/
 export const AccessDeniedProblemMeta = new Metadata.Struct(_pkg, "AccessDeniedProblem");
 new Metadata.Property(AccessDeniedProblemMeta, "message", {
     NonNullable: true,
     SubType: "builtin",
     Builtin: "string"
 });
-;
-;
-export class AccessDeniedProblem extends Error {
+/** struct AccessDeniedProblem
+*/
+export class AccessDeniedProblem extends Runtime.RpcError {
+    get __structPath() {
+        return AccessDeniedProblemMeta.path;
+    }
 }
 AccessDeniedProblemMeta.problemInstantiate = (msg) => new AccessDeniedProblem(msg);
+/** Struct metadata
+*/
 export const ForbiddenProblemMeta = new Metadata.Struct(_pkg, "ForbiddenProblem");
 new Metadata.Property(ForbiddenProblemMeta, "message", {
     NonNullable: true,
     SubType: "builtin",
     Builtin: "string"
 });
-;
-;
-export class ForbiddenProblem extends Error {
+/** struct ForbiddenProblem
+*/
+export class ForbiddenProblem extends Runtime.RpcError {
+    get __structPath() {
+        return ForbiddenProblemMeta.path;
+    }
 }
 ForbiddenProblemMeta.problemInstantiate = (msg) => new ForbiddenProblem(msg);
+/** Struct metadata
+*/
+export const ProblemActionMeta = new Metadata.Struct(_pkg, "ProblemAction");
+new Metadata.Property(ProblemActionMeta, "id", {
+    NonNullable: true,
+    SubType: "builtin",
+    Builtin: "string"
+});
+new Metadata.Property(ProblemActionMeta, "locale", {
+    NonNullable: false,
+    SubType: "builtin",
+    Builtin: "string"
+});
+new Metadata.Property(ProblemActionMeta, "title", {
+    NonNullable: true,
+    SubType: "builtin",
+    Builtin: "string"
+});
+new Metadata.Property(ProblemActionMeta, "url", {
+    NonNullable: false,
+    SubType: "builtin",
+    Builtin: "string"
+});
+/** Struct metadata
+*/
+export const ThrottledProblemMeta = new Metadata.Struct(_pkg, "ThrottledProblem");
+new Metadata.Property(ThrottledProblemMeta, "actions", {
+    NonNullable: true,
+    SubType: "array",
+    Item: {
+        NonNullable: true,
+        SubType: "userDefined",
+        Type: SpecularPackage().requireTypeByName("ProblemAction")
+    }
+});
+new Metadata.Property(ThrottledProblemMeta, "message", {
+    NonNullable: true,
+    SubType: "builtin",
+    Builtin: "string"
+});
+new Metadata.Property(ThrottledProblemMeta, "retryAfterMs", {
+    NonNullable: false,
+    SubType: "builtin",
+    Builtin: "int64"
+});
+/** Raised when the caller is being throttled and should retry later.
+*/
+export class ThrottledProblem extends Runtime.RpcError {
+    actions = [];
+    retryAfterMs = null;
+    get __structPath() {
+        return ThrottledProblemMeta.path;
+    }
+}
+ThrottledProblemMeta.problemInstantiate = (msg) => new ThrottledProblem(msg);
+/** Struct metadata
+*/
+export const QuotaExceededProblemMeta = new Metadata.Struct(_pkg, "QuotaExceededProblem");
+new Metadata.Property(QuotaExceededProblemMeta, "actions", {
+    NonNullable: true,
+    SubType: "array",
+    Item: {
+        NonNullable: true,
+        SubType: "userDefined",
+        Type: SpecularPackage().requireTypeByName("ProblemAction")
+    }
+});
+new Metadata.Property(QuotaExceededProblemMeta, "message", {
+    NonNullable: true,
+    SubType: "builtin",
+    Builtin: "string"
+});
+/** Raised when a resource quota has been exceeded.
+*/
+export class QuotaExceededProblem extends Runtime.RpcError {
+    actions = [];
+    get __structPath() {
+        return QuotaExceededProblemMeta.path;
+    }
+}
+QuotaExceededProblemMeta.problemInstantiate = (msg) => new QuotaExceededProblem(msg);
 export function SpecularPackage() {
     return _pkg;
 }

package/specular.ts

@@ -1,23 +1,28 @@
-// JS gen package
 import {
     Runtime,
     Metadata,
 } from '@deployport/specular-runtime';
 
-// SignedOperationV1 entity
-// Marks an operation with digital signature authentication for id4ntity verification
+/** Marks an operation with digital signature authentication for id4ntity verification
+*/
 export class SignedOperationV1 {
 }
 
-// ServiceSignatureV1 entity
+/** entity ServiceSignatureV1
+*/
 export class ServiceSignatureV1 {
+    /** serviceName parameter
+*/
     public ServiceName: string = '';
 }
 
 const _pkg = new Metadata.Package(
-    'Deployport/CoreLib',
+    "deployport", 
+    "corelib",
 );
 
+/** Struct metadata
+*/
 export const AccessDeniedProblemMeta = new Metadata.Struct(
     _pkg, 
     "AccessDeniedProblem", 
@@ -27,20 +32,23 @@ NonNullable: true,
 SubType: "builtin",
 Builtin: "string"
 });
-// AccessDeniedProblem entity
-export interface AccessDeniedProblemProperties
- {
-    // /**
-    // * Returns "Deployport/CoreLib:AccessDeniedProblem"
-    // */
-    // fqtn: "Deployport/CoreLib:AccessDeniedProblem";
-    message : string;
-};
-export interface AccessDeniedProblem extends AccessDeniedProblemProperties, Runtime.StructInterface{};
-export class AccessDeniedProblem 
-    extends Error
-{}
+/** struct AccessDeniedProblem
+*/
+export interface AccessDeniedProblemProperties {
+    /** message property
+*/
+    message : string
+}
+/** struct AccessDeniedProblem
+*/
+export class AccessDeniedProblem extends Runtime.RpcError implements AccessDeniedProblemProperties, Runtime.StructInterface {
+    get __structPath(): Metadata.StructPath {
+        return AccessDeniedProblemMeta.path
+    }
+}
 AccessDeniedProblemMeta.problemInstantiate = (msg: string) => new AccessDeniedProblem(msg);
+/** Struct metadata
+*/
 export const ForbiddenProblemMeta = new Metadata.Struct(
     _pkg, 
     "ForbiddenProblem", 
@@ -50,20 +58,159 @@ NonNullable: true,
 SubType: "builtin",
 Builtin: "string"
 });
-// ForbiddenProblem entity
-export interface ForbiddenProblemProperties
- {
-    // /**
-    // * Returns "Deployport/CoreLib:ForbiddenProblem"
-    // */
-    // fqtn: "Deployport/CoreLib:ForbiddenProblem";
-    message : string;
-};
-export interface ForbiddenProblem extends ForbiddenProblemProperties, Runtime.StructInterface{};
-export class ForbiddenProblem 
-    extends Error
-{}
+/** struct ForbiddenProblem
+*/
+export interface ForbiddenProblemProperties {
+    /** message property
+*/
+    message : string
+}
+/** struct ForbiddenProblem
+*/
+export class ForbiddenProblem extends Runtime.RpcError implements ForbiddenProblemProperties, Runtime.StructInterface {
+    get __structPath(): Metadata.StructPath {
+        return ForbiddenProblemMeta.path
+    }
+}
 ForbiddenProblemMeta.problemInstantiate = (msg: string) => new ForbiddenProblem(msg);
+/** Struct metadata
+*/
+export const ProblemActionMeta = new Metadata.Struct(
+    _pkg, 
+    "ProblemAction", 
+);
+new Metadata.Property(ProblemActionMeta, "id", {
+NonNullable: true,
+SubType: "builtin",
+Builtin: "string"
+});
+new Metadata.Property(ProblemActionMeta, "locale", {
+NonNullable: false,
+SubType: "builtin",
+Builtin: "string"
+});
+new Metadata.Property(ProblemActionMeta, "title", {
+NonNullable: true,
+SubType: "builtin",
+Builtin: "string"
+});
+new Metadata.Property(ProblemActionMeta, "url", {
+NonNullable: false,
+SubType: "builtin",
+Builtin: "string"
+});
+/** A localized call-to-action surfaced alongside a problem. Title and URL
+* are already resolved to a specific locale; clients render them as-is.
+*/
+export interface ProblemActionProperties {
+    /** Optional stable identifier. Clients can key on it to apply custom
+* presentation (icon, ordering) per well-known action.
+*/
+    id : string
+    /** BCP 47 tag of the locale the title and url were resolved to. May
+* differ from the caller's requested locale when a fallback was used.
+*/
+    locale : string| null
+    /** title property
+*/
+    title : string
+    /** url property
+*/
+    url : string| null
+}
+/** A localized call-to-action surfaced alongside a problem. Title and URL
+* are already resolved to a specific locale; clients render them as-is.
+*/
+export interface ProblemAction extends ProblemActionProperties, Runtime.StructInterface {}
+/** Struct metadata
+*/
+export const ThrottledProblemMeta = new Metadata.Struct(
+    _pkg, 
+    "ThrottledProblem", 
+);
+new Metadata.Property(ThrottledProblemMeta, "actions", {
+NonNullable: true,
+SubType: "array",
+Item: {
+NonNullable: true,
+SubType: "userDefined",
+Type: SpecularPackage().requireTypeByName("ProblemAction")
+}
+});
+new Metadata.Property(ThrottledProblemMeta, "message", {
+NonNullable: true,
+SubType: "builtin",
+Builtin: "string"
+});
+new Metadata.Property(ThrottledProblemMeta, "retryAfterMs", {
+NonNullable: false,
+SubType: "builtin",
+Builtin: "int64"
+});
+/** Raised when the caller is being throttled and should retry later.
+*/
+export interface ThrottledProblemProperties {
+    /** Optional calls-to-action to help the caller (e.g. support, upgrade,
+* docs links), ordered most-specific first. Empty when none apply.
+*/
+    actions : (ProblemActionProperties)[]
+    /** message property
+*/
+    message : string
+    /** Milliseconds the caller should wait before retrying.
+*/
+    retryAfterMs : number| null
+}
+/** Raised when the caller is being throttled and should retry later.
+*/
+export class ThrottledProblem extends Runtime.RpcError implements ThrottledProblemProperties, Runtime.StructInterface {
+    actions : (ProblemActionProperties)[] = []
+    retryAfterMs : number| null = null
+    get __structPath(): Metadata.StructPath {
+        return ThrottledProblemMeta.path
+    }
+}
+ThrottledProblemMeta.problemInstantiate = (msg: string) => new ThrottledProblem(msg);
+/** Struct metadata
+*/
+export const QuotaExceededProblemMeta = new Metadata.Struct(
+    _pkg, 
+    "QuotaExceededProblem", 
+);
+new Metadata.Property(QuotaExceededProblemMeta, "actions", {
+NonNullable: true,
+SubType: "array",
+Item: {
+NonNullable: true,
+SubType: "userDefined",
+Type: SpecularPackage().requireTypeByName("ProblemAction")
+}
+});
+new Metadata.Property(QuotaExceededProblemMeta, "message", {
+NonNullable: true,
+SubType: "builtin",
+Builtin: "string"
+});
+/** Raised when a resource quota has been exceeded.
+*/
+export interface QuotaExceededProblemProperties {
+    /** Optional calls-to-action to help the caller (e.g. request an increase,
+* upgrade, docs links), ordered most-specific first. Empty when none apply.
+*/
+    actions : (ProblemActionProperties)[]
+    /** message property
+*/
+    message : string
+}
+/** Raised when a resource quota has been exceeded.
+*/
+export class QuotaExceededProblem extends Runtime.RpcError implements QuotaExceededProblemProperties, Runtime.StructInterface {
+    actions : (ProblemActionProperties)[] = []
+    get __structPath(): Metadata.StructPath {
+        return QuotaExceededProblemMeta.path
+    }
+}
+QuotaExceededProblemMeta.problemInstantiate = (msg: string) => new QuotaExceededProblem(msg);
 
 export function SpecularPackage() {
     return _pkg;

package/specular.yaml

@@ -1,5 +1,9 @@
 packages:
-  - origin: "file://./../api-services-core-lib//package.specular"
+  - origin: "file://./../api-services-corelib-go//package.specular"
+    version: 0.0.2
+    path:
+      namespace: deployport
+      module: corelib
     generate:
       - language: js
         client:

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+    "extends": "@tsconfig/node24/tsconfig.json",
+    "compilerOptions": {
+        "declaration": true,
+        "types": ["node"]
+    },
+    "files": ["configurator/index.ts"]
+}