@latticexyz/store 2.2.18-9fa07c8489f1fbf167d0db01cd9aaa645a29c8e2 → 2.2.18-c2ad22c7feb566e1731ff16e8be291746bdffb3e

package/dist/store-7QsNcifl.d.cts

@@ -1,326 +0,0 @@
-import { conform, show, requiredKeyOf, ErrorMessage, narrow } from '@ark/util';
-import { r as Scope, A as AbiTypeScope, b as SchemaInput, t as getStaticAbiTypeKeys, e as TableInput, k as TableCodegen, f as TableShorthandInput, c as ScopedSchemaInput, g as TablesInput, U as UserTypes, u as extendScope, E as EnumsInput, N as NamespaceInput, h as NamespacesInput, q as Namespaces, S as StoreInput } from './output-DjNNBwhs.cjs';
-import { Hex } from 'viem';
-import { FixedArrayAbiType, fixedArrayToArray } from '@latticexyz/schema-type/internal';
-
-declare const storeEventsAbi: readonly [{
-    readonly name: "Store_SetRecord";
-    readonly type: "event";
-    readonly inputs: readonly [{
-        readonly type: "bytes32";
-        readonly name: "tableId";
-        readonly indexed: true;
-    }, {
-        readonly type: "bytes32[]";
-        readonly name: "keyTuple";
-    }, {
-        readonly type: "bytes";
-        readonly name: "staticData";
-    }, {
-        readonly type: "bytes32";
-        readonly name: "encodedLengths";
-    }, {
-        readonly type: "bytes";
-        readonly name: "dynamicData";
-    }];
-}, {
-    readonly name: "Store_SpliceStaticData";
-    readonly type: "event";
-    readonly inputs: readonly [{
-        readonly type: "bytes32";
-        readonly name: "tableId";
-        readonly indexed: true;
-    }, {
-        readonly type: "bytes32[]";
-        readonly name: "keyTuple";
-    }, {
-        readonly type: "uint48";
-        readonly name: "start";
-    }, {
-        readonly type: "bytes";
-        readonly name: "data";
-    }];
-}, {
-    readonly name: "Store_SpliceDynamicData";
-    readonly type: "event";
-    readonly inputs: readonly [{
-        readonly type: "bytes32";
-        readonly name: "tableId";
-        readonly indexed: true;
-    }, {
-        readonly type: "bytes32[]";
-        readonly name: "keyTuple";
-    }, {
-        readonly type: "uint8";
-        readonly name: "dynamicFieldIndex";
-    }, {
-        readonly type: "uint48";
-        readonly name: "start";
-    }, {
-        readonly type: "uint40";
-        readonly name: "deleteCount";
-    }, {
-        readonly type: "bytes32";
-        readonly name: "encodedLengths";
-    }, {
-        readonly type: "bytes";
-        readonly name: "data";
-    }];
-}, {
-    readonly name: "Store_DeleteRecord";
-    readonly type: "event";
-    readonly inputs: readonly [{
-        readonly type: "bytes32";
-        readonly name: "tableId";
-        readonly indexed: true;
-    }, {
-        readonly type: "bytes32[]";
-        readonly name: "keyTuple";
-    }];
-}];
-type storeEventsAbi = typeof storeEventsAbi;
-type StoreEventsAbi = typeof storeEventsAbi;
-type StoreEventsAbiItem = (typeof storeEventsAbi)[number];
-type StoreSetRecordEventAbiItem = StoreEventsAbiItem & {
-    readonly name: "Store_SetRecord";
-};
-
-type get<input, key> = key extends keyof input ? input[key] : undefined;
-declare function get<input, key extends PropertyKey>(input: input, key: key): get<input, key>;
-type getPath<input, path extends readonly PropertyKey[]> = path extends readonly [
-    infer head,
-    ...infer tail extends PropertyKey[]
-] ? head extends keyof input ? getPath<input[head], tail> : undefined : input;
-declare function getPath<input, path extends readonly PropertyKey[]>(input: input, path: path): getPath<input, path>;
-declare function hasOwnKey<obj, const key extends PropertyKey>(object: obj, key: key): object is {
-    [k in key]: k extends keyof obj ? obj[k] : unknown;
-} & obj;
-declare function isObject<input>(input: input): input is input & object;
-type mergeIfUndefined<base, defaults> = {
-    readonly [key in keyof base | keyof defaults]: key extends keyof base ? undefined extends base[key] ? key extends keyof defaults ? defaults[key] : base[key] : base[key] : key extends keyof defaults ? defaults[key] : never;
-};
-declare function mergeIfUndefined<base extends object, defaults extends object>(base: base, defaults: defaults): mergeIfUndefined<base, defaults>;
-type parseNumber<T> = T extends `${infer N extends number}` ? N : never;
-
-declare const CODEGEN_DEFAULTS: {
-    readonly storeImportPath: "@latticexyz/store/src";
-    readonly userTypesFilename: "common.sol";
-    readonly outputDirectory: "codegen";
-    readonly indexFilename: "index.sol";
-};
-type CODEGEN_DEFAULTS = typeof CODEGEN_DEFAULTS;
-declare const TABLE_CODEGEN_DEFAULTS: {
-    readonly outputDirectory: string;
-    readonly tableIdArgument: false;
-    readonly storeArgument: false;
-};
-type TABLE_CODEGEN_DEFAULTS = typeof TABLE_CODEGEN_DEFAULTS;
-declare const TABLE_DEPLOY_DEFAULTS: {
-    readonly disabled: false;
-};
-type TABLE_DEPLOY_DEFAULTS = typeof TABLE_DEPLOY_DEFAULTS;
-declare const TABLE_DEFAULTS: {
-    readonly namespaceLabel: "";
-    readonly type: "table";
-};
-type TABLE_DEFAULTS = typeof TABLE_DEFAULTS;
-declare const CONFIG_DEFAULTS: {
-    readonly sourceDirectory: "src";
-    readonly namespace: "";
-};
-type CONFIG_DEFAULTS = typeof CONFIG_DEFAULTS;
-
-type validateSchema<schema, scope extends Scope = AbiTypeScope> = schema extends string ? SchemaInput : {
-    [key in keyof schema]: schema[key] extends FixedArrayAbiType ? schema[key] : conform<schema[key], keyof scope["types"]>;
-};
-declare function validateSchema<scope extends Scope = AbiTypeScope>(schema: unknown, scope?: scope): asserts schema is SchemaInput;
-type resolveSchema<schema, scope extends Scope> = show<{
-    readonly [key in keyof schema]: {
-        /** the Solidity primitive ABI type */
-        readonly type: schema[key] extends FixedArrayAbiType ? fixedArrayToArray<schema[key]> : scope["types"][schema[key] & keyof scope["types"]];
-        /** the user defined type or Solidity primitive ABI type */
-        readonly internalType: schema[key];
-    };
-}>;
-declare function resolveSchema<schema extends SchemaInput, scope extends Scope = AbiTypeScope>(schema: schema, scope?: scope): resolveSchema<schema, scope>;
-declare function defineSchema<schema, scope extends AbiTypeScope = AbiTypeScope>(schema: validateSchema<schema, scope>, scope?: scope): resolveSchema<schema, scope>;
-declare function isSchemaInput<scope extends Scope = AbiTypeScope>(input: unknown, scope?: scope): input is SchemaInput;
-
-type ValidKeys<schema extends SchemaInput, scope extends Scope> = readonly [
-    getStaticAbiTypeKeys<schema, scope>,
-    ...getStaticAbiTypeKeys<schema, scope>[]
-];
-declare function isValidPrimaryKey<schema extends SchemaInput, scope extends Scope>(key: unknown, schema: schema, scope?: scope): key is ValidKeys<schema, scope>;
-type validateKeys<validKeys extends PropertyKey, keys> = keys extends readonly string[] ? {
-    readonly [i in keyof keys]: keys[i] extends validKeys ? keys[i] : validKeys;
-} : readonly string[];
-type ValidateTableOptions = {
-    inStoreContext: boolean;
-};
-type requiredTableKey<inStoreContext extends boolean> = Exclude<requiredKeyOf<TableInput>, inStoreContext extends true ? "label" | "namespaceLabel" | "namespace" : never>;
-type validateTable<input, scope extends Scope = AbiTypeScope, options extends ValidateTableOptions = {
-    inStoreContext: false;
-}> = {
-    [key in keyof input | requiredTableKey<options["inStoreContext"]>]: key extends "key" ? validateKeys<getStaticAbiTypeKeys<conform<get<input, "schema">, SchemaInput>, scope>, get<input, key>> : key extends "schema" ? validateSchema<get<input, key>, scope> : key extends "label" | "namespaceLabel" | "namespace" ? options["inStoreContext"] extends true ? ErrorMessage<"Overrides of `label`, `namespaceLabel`, and `namespace` are not allowed for tables in this context"> : key extends keyof input ? narrow<input[key]> : never : key extends keyof TableInput ? TableInput[key] : ErrorMessage<`Key \`${key & string}\` does not exist in TableInput`>;
-};
-declare function validateTable<input, scope extends Scope = AbiTypeScope>(input: input, scope?: scope, options?: ValidateTableOptions): asserts input is TableInput & input;
-type resolveTableCodegen<input extends TableInput> = show<{
-    [key in keyof TableCodegen]-?: key extends keyof input["codegen"] ? undefined extends input["codegen"][key] ? key extends "dataStruct" ? boolean : key extends keyof TABLE_CODEGEN_DEFAULTS ? TABLE_CODEGEN_DEFAULTS[key] : never : input["codegen"][key] : key extends "dataStruct" ? boolean : key extends keyof TABLE_CODEGEN_DEFAULTS ? TABLE_CODEGEN_DEFAULTS[key] : never;
-}>;
-declare function resolveTableCodegen<input extends TableInput>(input: input): resolveTableCodegen<input>;
-type resolveTable<input, scope extends Scope = Scope> = input extends TableInput ? {
-    readonly label: input["label"];
-    readonly namespaceLabel: undefined extends input["namespaceLabel"] ? typeof TABLE_DEFAULTS.namespaceLabel : input["namespaceLabel"];
-    readonly type: undefined extends input["type"] ? typeof TABLE_DEFAULTS.type : input["type"];
-    readonly namespace: string;
-    readonly name: string;
-    readonly tableId: Hex;
-    readonly schema: resolveSchema<input["schema"], scope>;
-    readonly key: Readonly<input["key"]>;
-    readonly codegen: resolveTableCodegen<input>;
-    readonly deploy: show<mergeIfUndefined<undefined extends input["deploy"] ? {} : input["deploy"], TABLE_DEPLOY_DEFAULTS>>;
-} : never;
-declare function resolveTable<input extends TableInput, scope extends Scope = AbiTypeScope>(input: input, scope?: scope): resolveTable<input, scope>;
-declare function defineTable<input, scope extends Scope = AbiTypeScope>(input: validateTable<input, scope>, scope?: scope): resolveTable<input, scope>;
-
-declare const NoStaticKeyFieldError = "Invalid schema. Expected an `id` field with a static ABI type or an explicit `key` option.";
-type NoStaticKeyFieldError = ErrorMessage<typeof NoStaticKeyFieldError>;
-declare function isTableShorthandInput(shorthand: unknown): shorthand is TableShorthandInput;
-type validateTableShorthand<input, scope extends Scope = AbiTypeScope> = input extends SchemaInput ? "id" extends getStaticAbiTypeKeys<input, scope> ? conform<input, ScopedSchemaInput<scope>> : NoStaticKeyFieldError : input extends FixedArrayAbiType | keyof scope["types"] ? input : input extends string ? keyof scope["types"] : ScopedSchemaInput<scope>;
-declare function validateTableShorthand<scope extends Scope = AbiTypeScope>(shorthand: unknown, scope?: scope): asserts shorthand is TableShorthandInput;
-type expandTableShorthand<shorthand> = shorthand extends string ? {
-    readonly schema: {
-        readonly id: "bytes32";
-        readonly value: shorthand;
-    };
-    readonly key: ["id"];
-} : shorthand extends SchemaInput ? {
-    readonly schema: shorthand;
-    readonly key: ["id"];
-} : shorthand;
-declare function expandTableShorthand<shorthand, scope extends Scope = AbiTypeScope>(shorthand: shorthand, scope: scope): expandTableShorthand<shorthand>;
-declare function defineTableShorthand<input, scope extends Scope = AbiTypeScope>(input: validateTableShorthand<input, scope>, scope?: scope): expandTableShorthand<input>;
-
-type validateTables<tables, scope extends Scope = AbiTypeScope> = {
-    [label in keyof tables]: tables[label] extends TableShorthandInput ? validateTableShorthand<tables[label], scope> : tables[label] extends object ? validateTable<tables[label], scope, {
-        inStoreContext: true;
-    }> : ErrorMessage<`Expected tables config.`>;
-};
-declare function validateTables<scope extends Scope = AbiTypeScope>(input: unknown, scope: scope): asserts input is TablesInput;
-type resolveTables<tables, scope extends Scope = AbiTypeScope> = {
-    readonly [label in keyof tables]: resolveTable<mergeIfUndefined<expandTableShorthand<tables[label]>, {
-        readonly label: label;
-    }>, scope>;
-};
-declare function resolveTables<tables extends TablesInput, scope extends Scope = AbiTypeScope>(tables: tables, scope: scope): resolveTables<tables, scope>;
-declare function defineTables<input, scope extends Scope = AbiTypeScope>(input: validateTables<input, scope>, scope?: scope): show<resolveTables<input, scope>>;
-
-type extractInternalType<userTypes extends UserTypes> = {
-    [key in keyof userTypes]: userTypes[key]["type"];
-};
-declare function extractInternalType<userTypes extends UserTypes>(userTypes: userTypes): extractInternalType<userTypes>;
-declare function isUserTypes(userTypes: unknown): userTypes is UserTypes;
-type scopeWithUserTypes<userTypes, scope extends AbiTypeScope = AbiTypeScope> = UserTypes extends userTypes ? scope : userTypes extends UserTypes ? extendScope<scope, extractInternalType<userTypes>> : scope;
-declare function scopeWithUserTypes<userTypes, scope extends AbiTypeScope = AbiTypeScope>(userTypes: userTypes, scope?: scope): scopeWithUserTypes<userTypes, scope>;
-declare function validateUserTypes(userTypes: unknown): asserts userTypes is UserTypes;
-
-type scopeWithEnums<enums, scope extends AbiTypeScope = AbiTypeScope> = EnumsInput extends enums ? scope : enums extends EnumsInput ? extendScope<scope, {
-    [key in keyof enums]: "uint8";
-}> : scope;
-declare function scopeWithEnums<enums, scope extends AbiTypeScope = AbiTypeScope>(enums: enums, scope?: scope): scopeWithEnums<enums, scope>;
-type resolveEnums<enums> = {
-    readonly [key in keyof enums]: Readonly<enums[key]>;
-};
-declare function resolveEnums<enums extends EnumsInput>(enums: enums): resolveEnums<enums>;
-type mapEnums<enums> = {
-    readonly [key in keyof enums]: {
-        readonly [element in keyof enums[key] & `${number}` as enums[key][element] & string]: parseNumber<element>;
-    };
-};
-declare function mapEnums<enums extends EnumsInput>(enums: enums): resolveEnums<enums>;
-
-type resolveCodegen<codegen> = codegen extends {} ? show<mergeIfUndefined<codegen, CODEGEN_DEFAULTS>> : CODEGEN_DEFAULTS;
-declare function resolveCodegen<codegen>(codegen: codegen): resolveCodegen<codegen>;
-
-type validateNamespace<input, scope extends Scope = AbiTypeScope> = {
-    [key in keyof input]: key extends "tables" ? validateTables<input[key], scope> : key extends keyof NamespaceInput ? NamespaceInput[key] : ErrorMessage<`\`${key & string}\` is not a valid namespace config option.`>;
-};
-declare function validateNamespace<scope extends Scope = AbiTypeScope>(input: unknown, scope: scope): asserts input is NamespaceInput;
-type resolveNamespace<input, scope extends Scope = AbiTypeScope> = input extends NamespaceInput ? {
-    readonly label: input["label"];
-    readonly namespace: string;
-    readonly tables: undefined extends input["tables"] ? {} : show<resolveTables<{
-        readonly [label in keyof input["tables"]]: mergeIfUndefined<expandTableShorthand<input["tables"][label]>, {
-            readonly namespace: string;
-            readonly namespaceLabel: input["label"];
-        }>;
-    }, scope>>;
-} : never;
-declare function resolveNamespace<const input extends NamespaceInput, scope extends Scope = AbiTypeScope>(input: input, scope?: scope): resolveNamespace<input, scope>;
-
-type validateNamespaces<namespaces, scope extends Scope = AbiTypeScope> = {
-    [label in keyof namespaces]: validateNamespace<namespaces[label], scope>;
-};
-declare function validateNamespaces<scope extends Scope = AbiTypeScope>(namespaces: unknown, scope: scope): asserts namespaces is NamespacesInput;
-type resolveNamespaces<namespaces, scope extends Scope = AbiTypeScope> = {
-    readonly [label in keyof namespaces]: resolveNamespace<mergeIfUndefined<namespaces[label], {
-        label: label;
-    }>, scope>;
-};
-declare function resolveNamespaces<input extends NamespacesInput, scope extends Scope = AbiTypeScope>(input: input, scope: scope): resolveNamespaces<input, scope>;
-declare function defineNamespaces<input, scope extends Scope = AbiTypeScope>(input: validateNamespaces<input, scope>, scope?: scope): show<resolveNamespaces<input, scope>>;
-
-type flattenNamespacedTableKeys<config> = config extends {
-    readonly namespaces: infer namespaces;
-} ? {
-    [namespaceLabel in keyof namespaces]: namespaces[namespaceLabel] extends {
-        readonly tables: infer tables;
-    } ? namespaceLabel extends "" ? keyof tables : `${namespaceLabel & string}__${keyof tables & string}` : never;
-}[keyof namespaces] : never;
-/**
- * @internal Only kept for backwards compatibility
- */
-type flattenNamespacedTables<config> = config extends {
-    readonly namespaces: Namespaces;
-} ? {
-    readonly [key in flattenNamespacedTableKeys<config>]: key extends `${infer namespaceLabel}__${infer tableLabel}` ? config["namespaces"][namespaceLabel]["tables"][tableLabel] : config["namespaces"][""]["tables"][key];
-} : never;
-/**
- * @internal Only kept for backwards compatibility
- */
-declare function flattenNamespacedTables<config extends {
-    readonly namespaces: Namespaces;
-}>(config: config): show<flattenNamespacedTables<config>>;
-
-type extendedScope<input> = scopeWithEnums<get<input, "enums">, scopeWithUserTypes<get<input, "userTypes">>>;
-declare function extendedScope<input>(input: input): extendedScope<input>;
-type validateStore<input> = {
-    [key in keyof input]: key extends "namespaces" ? input extends {
-        namespace?: unknown;
-        tables?: unknown;
-    } ? ErrorMessage<"Cannot use `namespaces` with `namespace` or `tables` keys."> : validateNamespaces<input[key], extendedScope<input>> : key extends "tables" ? validateTables<input[key], extendedScope<input>> : key extends "userTypes" ? UserTypes : key extends "enums" ? narrow<input[key]> : key extends keyof StoreInput ? StoreInput[key] : ErrorMessage<`\`${key & string}\` is not a valid Store config option.`>;
-};
-declare function validateStore(input: unknown): asserts input is StoreInput;
-type resolveNamespaceMode<input> = "namespaces" extends keyof input ? {
-    readonly multipleNamespaces: true;
-    readonly namespace: null;
-    readonly namespaces: show<resolveNamespaces<input["namespaces"], extendedScope<input>>>;
-} : {
-    readonly multipleNamespaces: false;
-    readonly namespace: string;
-    readonly namespaces: show<resolveNamespaces<{
-        readonly [label in "namespace" extends keyof input ? input["namespace"] extends string ? input["namespace"] : CONFIG_DEFAULTS["namespace"] : CONFIG_DEFAULTS["namespace"]]: input;
-    }, extendedScope<input>>>;
-};
-type resolveStore<input> = resolveNamespaceMode<input> & {
-    readonly tables: flattenNamespacedTables<resolveNamespaceMode<input>>;
-    readonly sourceDirectory: "sourceDirectory" extends keyof input ? input["sourceDirectory"] : CONFIG_DEFAULTS["sourceDirectory"];
-    readonly userTypes: "userTypes" extends keyof input ? input["userTypes"] : {};
-    readonly enums: "enums" extends keyof input ? show<resolveEnums<input["enums"]>> : {};
-    readonly enumValues: "enums" extends keyof input ? show<mapEnums<input["enums"]>> : {};
-    readonly codegen: "codegen" extends keyof input ? resolveCodegen<input["codegen"]> : resolveCodegen<{}>;
-};
-declare function resolveStore<const input extends StoreInput>(input: input): resolveStore<input>;
-declare function defineStore<const input>(input: validateStore<input>): show<resolveStore<input>>;
-
-export { scopeWithUserTypes as $, isSchemaInput as A, extendedScope as B, CODEGEN_DEFAULTS as C, validateStore as D, type resolveNamespaceMode as E, resolveStore as F, isValidPrimaryKey as G, type validateKeys as H, type ValidateTableOptions as I, type requiredTableKey as J, validateTable as K, resolveTableCodegen as L, resolveTable as M, defineTable as N, validateTables as O, resolveTables as P, defineTables as Q, NoStaticKeyFieldError as R, type StoreEventsAbi as S, TABLE_CODEGEN_DEFAULTS as T, isTableShorthandInput as U, type ValidKeys as V, validateTableShorthand as W, expandTableShorthand as X, defineTableShorthand as Y, extractInternalType as Z, isUserTypes as _, type StoreEventsAbiItem as a, validateUserTypes as a0, type StoreSetRecordEventAbiItem as b, TABLE_DEPLOY_DEFAULTS as c, defineStore as d, TABLE_DEFAULTS as e, CONFIG_DEFAULTS as f, scopeWithEnums as g, resolveEnums as h, flattenNamespacedTables as i, get as j, getPath as k, hasOwnKey as l, mapEnums as m, isObject as n, mergeIfUndefined as o, type parseNumber as p, resolveNamespace as q, resolveCodegen as r, storeEventsAbi as s, validateNamespaces as t, resolveNamespaces as u, validateNamespace as v, defineNamespaces as w, validateSchema as x, resolveSchema as y, defineSchema as z };