@0xobelisk/sui-common 1.2.0-pre.99 → 2.0.0

package/dist/index.d.ts

@@ -1,57 +1,91 @@
 declare function formatMove(content: string, prettierConfigPath?: string): Promise<string>;
-declare function formatTypescript(content: string): Promise<string>;
 
 declare function formatAndWriteMove(output: string, fullOutputPath: string, logPrefix?: string): Promise<void>;
-/**
- * Formats typescript code using prettier and write it to a file
- * @param output typescript code
- * @param fullOutputPath full path to the output file
- * @param logPrefix prefix for debug logs
- */
-declare function formatAndWriteTypescript(output: string, fullOutputPath: string, logPrefix: string): Promise<void>;
-
-/**
- * Explicitly normalize a given path to a posix path (using `/` as separator).
- * This should be used for generating Solidity files that will be consumed by solc,
- * because solc expects `/` as path separator, but path.join produces `\` if the user is on windows.
- */
-declare function posixPath(path: string): string;
 
 type ComponentType = 'Onchain' | 'Offchain';
 type MoveType = 'address' | 'bool' | 'u8' | 'u32' | 'u64' | 'u128' | 'u256' | 'String' | 'vector<address>' | 'vector<bool>' | 'vector<u8>' | 'vector<vector<u8>>' | 'vector<u32>' | 'vector<u64>' | 'vector<u128>' | 'vector<u256>' | string;
 type Component = {
     offchain?: boolean;
+    global?: boolean;
     fields: Record<string, MoveType>;
     keys?: string[];
+    reactive?: boolean;
+    fungible?: boolean;
+    transferable?: boolean;
+    listable?: boolean;
+};
+/** Config for a DApp-owned named shared object (e.g. guild, boss). */
+type ObjectConfig = {
+    fields: Record<string, MoveType>;
+    /** Resources (from the `resources` section) this object accepts for transfers. */
+    accepts?: string[];
+    /** Other objects/scenes whose data can be transferred into this object. */
+    acceptsFrom?: string[];
+    /** If true, only the DApp admin can call create_<key>. */
+    adminOnly?: boolean;
+};
+/** Config for a standalone ScenePermit (participant management only). */
+type PermitConfig = {};
+type SceneAuthorization = {
+    kind: 'permit';
+    permit: string;
+} | {
+    kind: 'system';
 };
-type EmptyComponent = Record<string, never>;
+/** Config for a SceneStorage object (pure data storage, symmetric to ObjectConfig). */
+type SceneConfig = {
+    fields: Record<string, MoveType>;
+    /** Resources this scene accepts for transfers. */
+    accepts?: string[];
+    /** Other objects/scenes whose data can be transferred into this scene. */
+    acceptsFrom?: string[];
+    /** Explicit write authorization model for this SceneStorage. */
+    authorization: SceneAuthorization;
+};
+type ErrorDefinition = {
+    message: string;
+};
+type ErrorEntry = string | ErrorDefinition;
 type DubheConfig = {
     name: string;
     description: string;
     enums?: Record<string, string[]>;
-    components: Record<string, Component | MoveType | EmptyComponent>;
-    resources: Record<string, Component | MoveType>;
-    errors?: Record<string, string>;
+    resources?: Record<string, Component | MoveType>;
+    objects?: Record<string, ObjectConfig>;
+    permits?: Record<string, PermitConfig>;
+    scenes?: Record<string, SceneConfig>;
+    errors?: Record<string, ErrorEntry>;
 };
 type DubheMetadata = {
-    components: Record<string, Component | MoveType | EmptyComponent>;
     resources: Record<string, Component | MoveType>;
     enums: Record<string, string[]>;
 };
 type BaseType = any;
-type ErrorData = any;
+type ErrorData = Record<string, ErrorEntry>;
 type EventData = any;
-type SchemaData = any;
-type SchemaType = any;
 
-declare function schemaGen(rootDir: string, config: DubheConfig, network?: 'mainnet' | 'testnet' | 'devnet' | 'localnet'): Promise<void>;
+declare function codegen(rootDir: string, config: DubheConfig, network?: 'mainnet' | 'testnet' | 'devnet' | 'localnet', initialMode?: 0 | 1): Promise<void>;
+/** @deprecated Use `codegen` instead. */
+declare const schemaGen: typeof codegen;
 
 declare const defineConfig: (config: DubheConfig) => DubheConfig;
 
+declare function generateObjects(config: DubheConfig, outputDir: string): Promise<void>;
+
+declare function generateScenes(config: DubheConfig, outputDir: string): Promise<void>;
+
 declare function loadConfig(configPath?: string): Promise<unknown>;
-declare function resolveConfigPath(configPath: string | undefined, toFileURL?: boolean): Promise<string>;
 
-declare const parseData: (data: any) => any;
+/**
+ * Read the existing lock file (if any), check for breaking changes against the
+ * current config, then write an updated lock file.
+ *
+ * Call this at the start of `codegen()` before any file generation begins.
+ *
+ * @param rootDir  The project root directory (same dir passed to `codegen()`).
+ * @param config   The parsed DubheConfig.
+ */
+declare function checkAndUpdateLock(rootDir: string, config: DubheConfig): void;
 
 declare enum SubscriptionKind {
     Event = "event",
@@ -66,4 +100,4 @@ type SubscribableType = {
     name?: string;
 };
 
-export { BaseType, Component, ComponentType, DubheConfig, DubheMetadata, EmptyComponent, ErrorData, EventData, MoveType, SchemaData, SchemaType, SubscribableType, SubscriptionKind, defineConfig, formatAndWriteMove, formatAndWriteTypescript, formatMove, formatTypescript, loadConfig, parseData, posixPath, resolveConfigPath, schemaGen };
+export { BaseType, Component, ComponentType, DubheConfig, DubheMetadata, ErrorData, ErrorDefinition, ErrorEntry, EventData, MoveType, ObjectConfig, PermitConfig, SceneAuthorization, SceneConfig, SubscribableType, SubscriptionKind, checkAndUpdateLock, codegen, defineConfig, formatAndWriteMove, formatMove, generateObjects, generateScenes, loadConfig, schemaGen };