@solana/options 2.0.0-20241006045741

package/dist/types/option.d.ts

@@ -0,0 +1,55 @@
+/**
+ * An implementation of the Rust Option type in JavaScript.
+ * It can be one of the following:
+ * - <code>{@link Some}<T></code>: Meaning there is a value of type T.
+ * - <code>{@link None}</code>: Meaning there is no value.
+ */
+export type Option<T> = None | Some<T>;
+/**
+ * Defines a looser type that can be used when serializing an {@link Option}.
+ * This allows us to pass null or the Option value directly whilst still
+ * supporting the Option type for use-cases that need more type safety.
+ */
+export type OptionOrNullable<T> = Option<T> | T | null;
+/**
+ * Represents an option of type `T` that has a value.
+ *
+ * @see {@link Option}
+ */
+export type Some<T> = Readonly<{
+    __option: 'Some';
+    value: T;
+}>;
+/**
+ * Represents an option of type `T` that has no value.
+ *
+ * @see {@link Option}
+ */
+export type None = Readonly<{
+    __option: 'None';
+}>;
+/**
+ * Creates a new {@link Option} of type `T` that has a value.
+ *
+ * @see {@link Option}
+ */
+export declare const some: <T>(value: T) => Option<T>;
+/**
+ * Creates a new {@link Option} of type `T` that has no value.
+ *
+ * @see {@link Option}
+ */
+export declare const none: <T>() => Option<T>;
+/**
+ * Whether the given data is an {@link Option}.
+ */
+export declare const isOption: <T = unknown>(input: unknown) => input is Option<T>;
+/**
+ * Whether the given {@link Option} is a {@link Some}.
+ */
+export declare const isSome: <T>(option: Option<T>) => option is Some<T>;
+/**
+ * Whether the given {@link Option} is a {@link None}.
+ */
+export declare const isNone: <T>(option: Option<T>) => option is None;
+//# sourceMappingURL=option.d.ts.map

package/dist/types/option.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"option.d.ts","sourceRoot":"","sources":["../../src/option.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;AAEvC;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,QAAQ,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC;AAE/D;;;;GAIG;AACH,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAElD;;;;GAIG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,CAAC,KAAG,MAAM,CAAC,CAAC,CAAkC,CAAC;AAE9E;;;;GAIG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,OAAK,MAAM,CAAC,CAAC,CAA2B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,mBAAmB,OAAO,KAAG,KAAK,IAAI,MAAM,CAAC,CAAC,CAMnE,CAAC;AAEN;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,UAAU,MAAM,CAAC,CAAC,CAAC,KAAG,MAAM,IAAI,IAAI,CAAC,CAAC,CAA+B,CAAC;AAE9F;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,UAAU,MAAM,CAAC,CAAC,CAAC,KAAG,MAAM,IAAI,IAAkC,CAAC"}

package/dist/types/unwrap-option-recursively.d.ts

@@ -0,0 +1,30 @@
+import { None, Some } from './option';
+/**
+ * Lists all types that should not be recursively unwrapped.
+ *
+ * @see {@link UnwrappedOption}
+ */
+type UnUnwrappables = Date | Int8Array | Int16Array | Int32Array | Uint8Array | Uint16Array | Uint32Array | bigint | boolean | number | string | symbol | null | undefined;
+/**
+ * A type that defines the recursive unwrapping of a type `T`
+ * such that all nested {@link Option} types are unwrapped.
+ *
+ * For each nested {@link Option} type, if the option is a {@link Some},
+ * it returns the type of its value, otherwise, it returns the provided
+ * fallback type `U` which defaults to `null`.
+ */
+export type UnwrappedOption<T, U = null> = T extends Some<infer TValue> ? UnwrappedOption<TValue, U> : T extends None ? U : T extends UnUnwrappables ? T : T extends object ? {
+    [key in keyof T]: UnwrappedOption<T[key], U>;
+} : T extends Array<infer TItem> ? Array<UnwrappedOption<TItem, U>> : T;
+/**
+ * Recursively go through a type `T` such that all
+ * nested {@link Option} types are unwrapped.
+ *
+ * For each nested {@link Option} type, if the option is a {@link Some},
+ * it returns its value, otherwise, it returns the provided fallback value
+ * which defaults to `null`.
+ */
+export declare function unwrapOptionRecursively<T>(input: T): UnwrappedOption<T>;
+export declare function unwrapOptionRecursively<T, U>(input: T, fallback: () => U): UnwrappedOption<T, U>;
+export {};
+//# sourceMappingURL=unwrap-option-recursively.d.ts.map

package/dist/types/unwrap-option-recursively.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unwrap-option-recursively.d.ts","sourceRoot":"","sources":["../../src/unwrap-option-recursively.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,IAAI,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAExD;;;;GAIG;AACH,KAAK,cAAc,GACb,IAAI,GACJ,SAAS,GACT,UAAU,GACV,UAAU,GACV,UAAU,GACV,WAAW,GACX,WAAW,GACX,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,GACN,IAAI,GACJ,SAAS,CAAC;AAEhB;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,IACnC,CAAC,SAAS,IAAI,CAAC,MAAM,MAAM,CAAC,GACtB,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,GAC1B,CAAC,SAAS,IAAI,GACZ,CAAC,GACD,CAAC,SAAS,cAAc,GACtB,CAAC,GACD,CAAC,SAAS,MAAM,GACd;KAAG,GAAG,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;CAAE,GAChD,CAAC,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,GAC1B,KAAK,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,GAChC,CAAC,CAAC;AAEpB;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;AACzE,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC"}

package/dist/types/unwrap-option.d.ts

@@ -0,0 +1,12 @@
+import { Option } from './option';
+/**
+ * Unwraps the value of an {@link Option} of type `T`
+ * or returns a fallback value that defaults to `null`.
+ */
+export declare function unwrapOption<T>(option: Option<T>): T | null;
+export declare function unwrapOption<T, U>(option: Option<T>, fallback: () => U): T | U;
+/**
+ * Wraps a nullable value into an {@link Option}.
+ */
+export declare const wrapNullable: <T>(nullable: T | null) => Option<T>;
+//# sourceMappingURL=unwrap-option.d.ts.map

package/dist/types/unwrap-option.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unwrap-option.d.ts","sourceRoot":"","sources":["../../src/unwrap-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,MAAM,EAAQ,MAAM,UAAU,CAAC;AAEtD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;AAC7D,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAMhF;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,YAAY,CAAC,GAAG,IAAI,KAAG,MAAM,CAAC,CAAC,CAAqD,CAAC"}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@solana/options",
+  "version": "2.0.0-20241006045741",
+  "description": "Managing and serializing Rust-like Option types in JavaScript",
+  "exports": {
+    "edge-light": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    },
+    "workerd": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    },
+    "browser": {
+      "import": "./dist/index.browser.mjs",
+      "require": "./dist/index.browser.cjs"
+    },
+    "node": {
+      "import": "./dist/index.node.mjs",
+      "require": "./dist/index.node.cjs"
+    },
+    "react-native": "./dist/index.native.mjs",
+    "types": "./dist/types/index.d.ts"
+  },
+  "browser": {
+    "./dist/index.node.cjs": "./dist/index.browser.cjs",
+    "./dist/index.node.mjs": "./dist/index.browser.mjs"
+  },
+  "main": "./dist/index.node.cjs",
+  "module": "./dist/index.node.mjs",
+  "react-native": "./dist/index.native.mjs",
+  "types": "./dist/types/index.d.ts",
+  "type": "commonjs",
+  "files": [
+    "./dist/"
+  ],
+  "sideEffects": false,
+  "keywords": [
+    "blockchain",
+    "solana",
+    "web3"
+  ],
+  "author": "Solana Labs Maintainers <maintainers@solanalabs.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/solana-labs/solana-web3.js"
+  },
+  "bugs": {
+    "url": "http://github.com/solana-labs/solana-web3.js/issues"
+  },
+  "browserslist": [
+    "supports bigint and not dead",
+    "maintained node versions"
+  ],
+  "engine": {
+    "node": ">=17.4"
+  },
+  "dependencies": {
+    "@solana/codecs-core": "2.0.0-20241006045741",
+    "@solana/codecs-data-structures": "2.0.0-20241006045741",
+    "@solana/codecs-numbers": "2.0.0-20241006045741",
+    "@solana/codecs-strings": "2.0.0-20241006045741",
+    "@solana/errors": "2.0.0-20241006045741"
+  },
+  "peerDependencies": {
+    "typescript": ">=5"
+  },
+  "bundlewatch": {
+    "defaultCompression": "gzip",
+    "files": [
+      {
+        "path": "./dist/index*.js"
+      }
+    ]
+  },
+  "scripts": {
+    "compile:js": "tsup --config build-scripts/tsup.config.package.ts",
+    "compile:typedefs": "tsc -p ./tsconfig.declarations.json",
+    "dev": "jest -c ../../node_modules/@solana/test-config/jest-dev.config.ts --rootDir . --watch",
+    "publish-impl": "npm view $npm_package_name@$npm_package_version > /dev/null 2>&1 || pnpm publish --tag ${PUBLISH_TAG:-canary} --access public --no-git-checks",
+    "publish-packages": "pnpm prepublishOnly && pnpm publish-impl",
+    "style:fix": "pnpm eslint --fix src && pnpm prettier --log-level warn --ignore-unknown --write ./*",
+    "test:lint": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-lint.config.ts --rootDir . --silent",
+    "test:prettier": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-prettier.config.ts --rootDir . --silent",
+    "test:treeshakability:browser": "agadoo dist/index.browser.mjs",
+    "test:treeshakability:native": "agadoo dist/index.node.mjs",
+    "test:treeshakability:node": "agadoo dist/index.native.mjs",
+    "test:typecheck": "tsc --noEmit",
+    "test:unit:browser": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-unit.config.browser.ts --rootDir . --silent",
+    "test:unit:node": "TERM_OVERRIDE=\"${TURBO_HASH:+dumb}\" TERM=${TERM_OVERRIDE:-$TERM} jest -c ../../node_modules/@solana/test-config/jest-unit.config.node.ts --rootDir . --silent"
+  }
+}