@tinycloudlabs/web-sdk-wasm 0.1.0

package/dist/tinycloud_web_sdk_rs.d.ts

@@ -0,0 +1,227 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Initialise console-error-panic-hook to improve debug output for panics.
+ *
+ * Run once on initialisation.
+ */
+export function initPanicHook(): void;
+export function makeOrbitId(address: string, chainId: number, name?: string | null): string;
+export function prepareSession(config: string): Promise<any>;
+export function completeSessionSetup(config: string): string;
+export function invoke(session: string, service: string, path: string, action: string): Promise<any>;
+export function generateHostSIWEMessage(config: string): string;
+export function siweToDelegationHeaders(signedSIWEMessage: string): string;
+
+export type ExtraFields = {
+    /** Any extra fields that are needed for the capability.
+     * This object must be serializable with JSON.stringify().
+     */
+    [key: string]: any
+}
+
+
+
+export type SiweConfig = {
+    /**Ethereum address performing the signing conformant to capitalization
+     * encoded checksum specified in EIP-55 where applicable. */
+    address: string;
+    /**EIP-155 Chain ID to which the session is bound, and the network where
+     * Contract Accounts must be resolved. */
+    chainId: number;
+    /**RFC 4501 dns authority that is requesting the signing. */
+    domain: string;
+    /**Randomized token used to prevent replay attacks, at least 8 alphanumeric
+     * characters. */
+    nonce?: string;
+    /**ISO 8601 datetime string of the current time. */
+    issuedAt: string;
+    /**ISO 8601 datetime string that, if present, indicates when the signed
+     * authentication message is no longer valid. */
+    expirationTime?: string;
+    /**ISO 8601 datetime string that, if present, indicates when the signed
+     * authentication message will become valid. */
+    notBefore?: string;
+    /**System-specific identifier that may be used to uniquely refer to the
+     * sign-in request. */
+    requestId?: string;
+    /**List of information or references to information the user wishes to have
+     * resolved as part of authentication by the relying party. They are
+     * expressed as RFC 3986 URIs separated by `\n- `. */
+    resources?: string[];
+    /**Human-readable ASCII assertion that the user will sign, and it must not
+     * contain `\n`. */
+    statement?: string;
+}
+
+
+
+/**
+ * Configuration object for starting a TinyCloud session.
+ */
+export type SessionConfig = {
+  /** Actions that the session key will be permitted to perform, organized by service and path */
+  actions: { [service: string]: { [key: string]: string[] }},
+  /** Ethereum address. */
+  address: string,
+  /** Chain ID. */
+  chainId: number,
+  /** Domain of the webpage. */
+  domain: string,
+  /** Current time for SIWE message. */
+  issuedAt: string,
+  /** The orbit that is the target resource of the delegation. */
+  orbitId: string,
+  /** The earliest time that the session will be valid from. */
+  notBefore?: string,
+  /** The latest time that the session will be valid until. */
+  expirationTime: string,
+  /** Optional parent delegations to inherit and attenuate */
+  parents?: string[]
+  /** Optional jwk to delegate to */
+  jwk?: object
+}
+
+
+
+/**
+ * A TinyCloud session.
+ */
+export type Session = {
+  /** The delegation from the user to the session key. */
+  delegationHeader: { Authorization: string },
+  /** The delegation reference from the user to the session key. */
+  delegationCid: string,
+  /** The session key. */
+  jwk: object,
+  /** The orbit that the session key is permitted to perform actions against. */
+  orbitId: string,
+  /** The verification method of the session key. */
+  verificationMethod: string,
+}
+
+
+
+/**
+ * Configuration object for generating a TinyCloud Orbit Host Delegation SIWE message.
+ */
+export type HostConfig = {
+  /** Ethereum address. */
+  address: string,
+  /** Chain ID. */
+  chainId: number,
+  /** Domain of the webpage. */
+  domain: string,
+  /** Current time for SIWE message. */
+  issuedAt: string,
+  /** The orbit that is the target resource of the delegation. */
+  orbitId: string,
+  /** The peer that is the target/invoker in the delegation. */
+  peerId: string,
+}
+
+
+export class TCWSessionManager {
+  free(): void;
+  /**
+   * Initialize a new TinyCloudWebSessionManager.
+   */
+  constructor();
+  /**
+   * Reset the SIWE message builder to its initial state.
+   */
+  resetBuilder(): void;
+  /**
+   * Build a SIWE message for signing.
+   */
+  build(config: SiweConfig, key_id?: string | null, custom_uri?: string | null): Promise<string>;
+  /**
+   * Add default actions to a capability.
+   */
+  addDefaultActions(namespace: string, defaultActions: string[]): boolean;
+  /**
+   * Add actions for a specific target to a capability.
+   */
+  addTargetedActions(namespace: string, target: string, actions: string[]): boolean;
+  /**
+   * Add extra fields to a capability.
+   */
+  addExtraFields(namespace: string, extraFields: ExtraFields): boolean;
+  /**
+   * Create a new session key with the given key ID (Defaults to 'default').
+   */
+  createSessionKey(key_id?: string | null): string;
+  /**
+   * List the available session keys.
+   */
+  listSessionKeys(): any;
+  /**
+   * Rename the key_id to retrieve session data.
+   */
+  renameSessionKeyId(old_key_id: string, new_key_id: string): Promise<void>;
+  /**
+   * Get the DID associated with a the session key key_id.
+   */
+  getDID(key_id?: string | null): Promise<string>;
+  /**
+   * Get the full JWK associated with a the session key key_id.
+   */
+  jwk(key_id?: string | null): string | undefined;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_tcwsessionmanager_free: (a: number, b: number) => void;
+  readonly tcwsessionmanager_new: () => [number, number, number];
+  readonly tcwsessionmanager_resetBuilder: (a: number) => void;
+  readonly tcwsessionmanager_build: (a: number, b: any, c: number, d: number, e: number, f: number) => any;
+  readonly tcwsessionmanager_addDefaultActions: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly tcwsessionmanager_addTargetedActions: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => number;
+  readonly tcwsessionmanager_addExtraFields: (a: number, b: number, c: number, d: any) => number;
+  readonly tcwsessionmanager_createSessionKey: (a: number, b: number, c: number) => [number, number, number, number];
+  readonly tcwsessionmanager_listSessionKeys: (a: number) => [number, number, number];
+  readonly tcwsessionmanager_renameSessionKeyId: (a: number, b: number, c: number, d: number, e: number) => any;
+  readonly tcwsessionmanager_getDID: (a: number, b: number, c: number) => any;
+  readonly tcwsessionmanager_jwk: (a: number, b: number, c: number) => [number, number];
+  readonly initPanicHook: () => void;
+  readonly makeOrbitId: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+  readonly prepareSession: (a: number, b: number) => any;
+  readonly completeSessionSetup: (a: number, b: number) => [number, number, number, number];
+  readonly invoke: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => any;
+  readonly generateHostSIWEMessage: (a: number, b: number) => [number, number, number, number];
+  readonly siweToDelegationHeaders: (a: number, b: number) => [number, number, number, number];
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly __externref_table_alloc: () => number;
+  readonly __wbindgen_export_4: WebAssembly.Table;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_export_6: WebAssembly.Table;
+  readonly __externref_table_dealloc: (a: number) => void;
+  readonly closure1383_externref_shim: (a: number, b: number, c: any) => void;
+  readonly closure2024_externref_shim: (a: number, b: number, c: any, d: any) => void;
+  readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+*
+* @returns {InitOutput}
+*/
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@tinycloudlabs/web-sdk-wasm",
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "TinyCloud, Inc.",
+  "license": "Apache-2.0 OR MIT",
+  "scripts": {
+    "build": "bun build-dev",
+    "build-dev": "wasm-pack build --dev --target web",
+    "build-release": "wasm-pack build --release --target web",
+    "bundle": "rollup -c && $PWD/fixup-types.sh",
+    "clean": "rm -rf dist pkg",
+    "dev": "yarn build-dev && yarn bundle",
+    "release": "yarn build-release && yarn bundle",
+    "fmt": "prettier -w src package.json rollup.config.js tsconfig.json",
+    "publish-gh": "npm config set @tinycloudlabs:registry=https://npm.pkg.github.com && npm publish",
+    "publish-npm": "npm config set @tinycloudlabs:registry=https://registry.npmjs.org && npm publish --access public"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.12",
+    "@rollup/plugin-wasm": "^5.2.0",
+    "prettier": "^2.8.8",
+    "rollup": "^2.79.2",
+    "rollup-plugin-typescript2": "^0.32.1",
+    "tslib": "^2.8.1",
+    "typescript": "^4.9.5"
+  },
+  "files": [
+    "tsconfig.json",
+    "dist"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "declaration": true
+  }
+}