@xyo-network/wasm 5.3.25 → 5.3.27

package/README.md

@@ -1,23 +1,584 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/wasm
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
 
-Version: 5.0.2
+Using yarn:
 
-Primary SDK for using XYO Protocol 2.0
+```sh
+yarn add {{name}}
+```
 
-## Documentation
+Using pnpm:
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__wasm)
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### protocol
+
+    ### packages
+
+      ### core
+
+        ### packages
+
+          ### wasm
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="WasmSupport"></a>WasmSupport
+
+[**@xyo-network/wasm**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new WasmSupport(desiredFeatures): WasmSupport;
+```
+
+Instance constructor for use where async instantiation
+is not possible. Where possible, prefer the static
+create method over use of this constructor directly
+as no initialization (feature detection) is able to
+be done here
+
+### Parameters
+
+#### desiredFeatures
+
+(
+  \| `"bigInt"`
+  \| `"bulkMemory"`
+  \| `"exceptions"`
+  \| `"extendedConst"`
+  \| `"gc"`
+  \| `"memory64"`
+  \| `"multiValue"`
+  \| `"mutableGlobals"`
+  \| `"referenceTypes"`
+  \| `"relaxedSimd"`
+  \| `"saturatedFloatToInt"`
+  \| `"signExtensions"`
+  \| `"simd"`
+  \| `"streamingCompilation"`
+  \| `"tailCall"`
+  \| `"threads"`)[]
+
+The desired feature set
+
+### Returns
+
+`WasmSupport`
+
+## Properties
+
+### desiredFeatures
+
+```ts
+protected desiredFeatures: (
+  | "bigInt"
+  | "bulkMemory"
+  | "exceptions"
+  | "extendedConst"
+  | "gc"
+  | "memory64"
+  | "multiValue"
+  | "mutableGlobals"
+  | "referenceTypes"
+  | "relaxedSimd"
+  | "saturatedFloatToInt"
+  | "signExtensions"
+  | "simd"
+  | "streamingCompilation"
+  | "tailCall"
+  | "threads")[];
+```
+
+## Accessors
+
+### allowWasm
+
+### Get Signature
+
+```ts
+get allowWasm(): boolean;
+```
+
+Is Wasm allowed
+
+#### Returns
+
+`boolean`
+
+### Set Signature
+
+```ts
+set allowWasm(v): void;
+```
+
+Whether or not to allow WASM usage
+
+#### Parameters
+
+##### v
+
+`boolean`
+
+#### Returns
+
+`void`
+
+***
+
+### canUseWasm
+
+### Get Signature
+
+```ts
+get canUseWasm(): boolean;
+```
+
+Whether or not Wasm should be used based on the desired
+feature set, initialization state, or force-use settings
+
+#### Returns
+
+`boolean`
+
+***
+
+### featureSupport
+
+### Get Signature
+
+```ts
+get featureSupport(): Readonly<Partial<Record<WasmFeature, boolean>>>;
+```
+
+Returns a object containing a property for each desired wasm feature
+with a boolean value indicating whether or not the feature is supported
+
+#### Returns
+
+`Readonly`\<`Partial`\<`Record`\<[`WasmFeature`](#../type-aliases/WasmFeature), `boolean`\>\>\>
+
+***
+
+### forceWasm
+
+### Get Signature
+
+```ts
+get forceWasm(): boolean;
+```
+
+Force use of Wasm
+
+#### Returns
+
+`boolean`
+
+### Set Signature
+
+```ts
+set forceWasm(v): void;
+```
+
+Whether or not to force Wasm usage
+
+#### Parameters
+
+##### v
+
+`boolean`
+
+#### Returns
+
+`void`
+
+***
+
+### isDesiredFeatureSetSupported
+
+### Get Signature
+
+```ts
+get isDesiredFeatureSetSupported(): boolean;
+```
+
+Whether or not Wasm is supported based
+on the desired feature set
+
+#### Returns
+
+`boolean`
+
+***
+
+### isInitialized
+
+### Get Signature
+
+```ts
+get isInitialized(): boolean;
+```
+
+Whether or not Wasm detection has been run
+for the desired feature set
+
+#### Returns
+
+`boolean`
+
+## Methods
+
+### create()
+
+```ts
+static create(desiredFeatures): Promise<WasmSupport>;
+```
+
+Static creation & async initialization for use where
+async instantiation is possible
+
+### Parameters
+
+#### desiredFeatures
+
+(
+  \| `"bigInt"`
+  \| `"bulkMemory"`
+  \| `"exceptions"`
+  \| `"extendedConst"`
+  \| `"gc"`
+  \| `"memory64"`
+  \| `"multiValue"`
+  \| `"mutableGlobals"`
+  \| `"referenceTypes"`
+  \| `"relaxedSimd"`
+  \| `"saturatedFloatToInt"`
+  \| `"signExtensions"`
+  \| `"simd"`
+  \| `"streamingCompilation"`
+  \| `"tailCall"`
+  \| `"threads"`)[]
+
+The desired feature set
+
+### Returns
+
+`Promise`\<`WasmSupport`\>
+
+An initialized instance of the class with detection
+for the desired feature set
+
+***
+
+### featureCheck()
+
+```ts
+featureCheck(features): Promise<boolean>;
+```
+
+Checks for specific wasm features
+
+### Parameters
+
+#### features
+
+(
+  \| `"bigInt"`
+  \| `"bulkMemory"`
+  \| `"exceptions"`
+  \| `"extendedConst"`
+  \| `"gc"`
+  \| `"memory64"`
+  \| `"multiValue"`
+  \| `"mutableGlobals"`
+  \| `"referenceTypes"`
+  \| `"relaxedSimd"`
+  \| `"saturatedFloatToInt"`
+  \| `"signExtensions"`
+  \| `"simd"`
+  \| `"streamingCompilation"`
+  \| `"tailCall"`
+  \| `"threads"`)[]
+
+The list of features to check for
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+True if all the features are supported, false otherwise
+
+***
+
+### initialize()
+
+```ts
+initialize(): Promise<void>;
+```
+
+Does feature detection for the desired feature set
+
+### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### detectDesiredFeatures()
+
+```ts
+protected detectDesiredFeatures(): Promise<void>;
+```
+
+### Returns
+
+`Promise`\<`void`\>
+
+              ### type-aliases
+
+                ### <a id="WasmFeature"></a>WasmFeature
+
+[**@xyo-network/wasm**](#../README)
+
+***
+
+```ts
+type WasmFeature = keyof typeof WasmFeatureDetectors;
+```
+
+              ### variables
+
+                ### <a id="WasmFeatureDetectors"></a>WasmFeatureDetectors
+
+[**@xyo-network/wasm**](#../README)
+
+***
+
+```ts
+const WasmFeatureDetectors: object;
+```
+
+## Type Declaration
+
+### bigInt
+
+```ts
+readonly bigInt: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### bulkMemory
+
+```ts
+readonly bulkMemory: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### exceptions
+
+```ts
+readonly exceptions: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### extendedConst
+
+```ts
+readonly extendedConst: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### gc
+
+```ts
+readonly gc: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### memory64
+
+```ts
+readonly memory64: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### multiValue
+
+```ts
+readonly multiValue: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### mutableGlobals
+
+```ts
+readonly mutableGlobals: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### referenceTypes
+
+```ts
+readonly referenceTypes: () => (executor) => Promise<boolean>;
+```
+
+### Returns
+
+```ts
+(executor): Promise<boolean>;
+```
+
+Creates a new Promise.
+
+#### Parameters
+
+##### executor
+
+(`resolve`, `reject`) => `void`
+
+A callback used to initialize the promise. This callback is passed two arguments:
+a resolve callback used to resolve the promise with a value or the result of another promise,
+and a reject callback used to reject the promise with a provided reason or error.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+### relaxedSimd
+
+```ts
+readonly relaxedSimd: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### saturatedFloatToInt
+
+```ts
+readonly saturatedFloatToInt: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### signExtensions
+
+```ts
+readonly signExtensions: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### simd
+
+```ts
+readonly simd: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### streamingCompilation
+
+```ts
+readonly streamingCompilation: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### tailCall
+
+```ts
+readonly tailCall: () => Promise<boolean>;
+```
+
+### Returns
+
+`Promise`\<`boolean`\>
+
+### threads
+
+```ts
+readonly threads: () => Promise<boolean>;
+```
+
+### Returns
 
-## Credits
+`Promise`\<`boolean`\>
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/wasm.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/wasm
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/wasm.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/wasm",
-  "version": "5.3.25",
+  "version": "5.3.27",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -40,9 +40,9 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@xylabs/sdk-js": "^5.0.93",
-    "@xylabs/tsconfig": "~7.6.16",
-    "@xylabs/vitest-extended": "~5.0.93",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/tsconfig": "~7.7.15",
+    "@xylabs/vitest-extended": "~5.0.94",
     "axios": "^1.14.0",
     "typescript": "~5.9.3",
     "vite": "^8.0.3",
@@ -51,8 +51,7 @@
     "zod": "^4.3.6"
   },
   "peerDependencies": {
-    "@xylabs/sdk-js": "^5",
-    "zod": "^4"
+    "@xylabs/sdk-js": "^5"
   },
   "publishConfig": {
     "access": "public"