@story-protocol/core-sdk 0.0.1-beta-rc.1

package/dist/declarations/src/types/resources/ipAsset.d.ts

@@ -0,0 +1,144 @@
+import { QueryOptions, TxOptions } from "../options.js";
+/**
+ * Core data model for IP Org.
+ *
+ * @public
+ */
+export type IPOrg = {
+    id: string;
+    name: string;
+    symbol: string;
+    owner: string;
+    baseUri?: string;
+    contractUri?: string;
+    ipAssetTypes: Array<string>;
+    createdAt: string;
+    txHash: string;
+};
+/**
+ * Request type for iporg.get method.
+ *
+ * @public
+ */
+export type GetIPOrgRequest = {
+    ipOrgId: string;
+};
+/**
+ * Response type for iporg.get method.
+ *
+ * @public
+ */
+export type GetIPOrgResponse = {
+    ipOrg: IPOrg;
+};
+/**
+ * Request type for iporg.create method.
+ *
+ * @public
+ */
+export type CreateIPOrgRequest = {
+    name: string;
+    symbol: string;
+    owner?: string;
+    ipAssetTypes: Array<string>;
+    txOptions?: TxOptions;
+};
+/**
+ * Response type for iporg.create method.
+ *
+ * @public
+ */
+export type CreateIPOrgResponse = {
+    txHash: string;
+    ipOrgId?: string;
+};
+/**
+ * Request type for iporg.list method.
+ *
+ * @public
+ */
+export type ListIPOrgRequest = {
+    options?: QueryOptions;
+};
+/**
+ * Response type for iporg.list method.
+ *
+ * @public
+ */
+export type ListIPOrgResponse = {
+    ipOrgs: IPOrg[];
+};
+export type IpAsset = {
+    id: string;
+    ipId: string;
+    chainId: number;
+    tokenContract: string;
+    tokenId: number;
+    metadataResolverAddress: string;
+};
+export type GetIpAssetRequest = {
+    ipId: string;
+};
+export type GetIpAssetResponse = {
+    data: IpAsset;
+};
+export type ListIpAssetRequest = {
+    options?: QueryOptions;
+};
+export type ListIpAssetResponse = {
+    data: IpAsset[];
+};
+export type RegisterIpAssetRequest = {
+    chainId: string;
+    tokenContractAddress: string;
+    tokenId: string;
+    txOptions?: TxOptions;
+};
+export type RegisterIpAssetResponse = {
+    txHash: string;
+    ipAccountId?: string;
+};
+export type RegisterRootIpRequest = {
+    policyId: string;
+    tokenContractAddress: string;
+    tokenId: string;
+    txOptions?: TxOptions;
+};
+export type RegisterRootIpResponse = {
+    txHash: string;
+    ipAccountId?: string;
+};
+export type RegisterDerivativeIpRequest = {
+    licenseId: string;
+    tokenContractAddress: string;
+    tokenId: string;
+    ipName: string;
+    ipDescription: string;
+    hash: string;
+    txOptions?: TxOptions;
+};
+export type RegisterDerivativeIpResponse = {
+    txHash: string;
+    ipAccountId?: string;
+};
+export type addPolicyRequest = {
+    frameworkId: string;
+    mintingParamValues: string[];
+    activationParamValues: string[];
+    needsActivation: boolean;
+    linkParentParamValues: string[];
+    txOptions?: TxOptions;
+};
+export type addPolicyToIpRequest = {
+    ipId: string;
+    policyId: string;
+};
+export type addPolicyResponse = {
+    txHash: string;
+    policyId?: number;
+    isNew?: boolean;
+};
+export type addPolicyToIpResponse = {
+    indexOnIpId: number;
+};
+//# sourceMappingURL=ipAsset.d.ts.map

package/dist/declarations/src/types/resources/ipAsset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AAErD;;;;GAIG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC;AAKF,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,uBAAuB,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAGhC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/declarations/src/types/resources/module.d.ts

@@ -0,0 +1,43 @@
+import { QueryOptions } from "../options.js";
+/**
+ * Core data model for modules.
+ *
+ * @public
+ */
+export type Module = {
+    name: string;
+    module: `0x${string}`;
+};
+/**
+ * Request type for module.get method.
+ *
+ * @public
+ */
+export type GetModuleRequest = {
+    name: string;
+};
+/**
+ * Response type for module.get method.
+ *
+ * @public
+ */
+export type GetModuleResponse = {
+    data: Module;
+};
+/**
+ * Response type for module.list method.
+ *
+ * @public
+ */
+export type ListModuleRequest = {
+    options?: QueryOptions;
+};
+/**
+ * Response type for module.list method.
+ *
+ * @public
+ */
+export type ListModuleResponse = {
+    data: Module[];
+};
+//# sourceMappingURL=module.d.ts.map

package/dist/declarations/src/types/resources/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,sBAAmB;AAE1C;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC"}

package/dist/declarations/src/types/resources/permission.d.ts

@@ -0,0 +1,35 @@
+import { QueryOptions, TxOptions } from "../options.js";
+export type setPermissionsRequest = {
+    ipAsset: string;
+    signer: string;
+    to: string;
+    func: string;
+    permission: number;
+    txOptions?: TxOptions;
+};
+export type Permission = {
+    id: string;
+    ipAccount: string;
+    permission: string;
+    signer: string;
+    to: string;
+    func: string;
+    blockTimestamp: string;
+    blockNumber: string;
+};
+export type setPermissionsResponse = {
+    txHash: string;
+};
+export type GetPermissionRequest = {
+    permissionId: string;
+};
+export type GetPermissionResponse = {
+    data: Permission;
+};
+export type ListPermissionsRequest = {
+    options: QueryOptions;
+};
+export type ListPermissionsResponse = {
+    data: Permission[];
+};
+//# sourceMappingURL=permission.d.ts.map

package/dist/declarations/src/types/resources/permission.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AAErD,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,YAAY,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,UAAU,EAAE,CAAC;CACpB,CAAC"}

package/dist/declarations/src/types/resources/tagging.d.ts

@@ -0,0 +1,35 @@
+import { QueryOptions, TxOptions } from "../options.js";
+export type Tag = {
+    id: string;
+    ipId: `0x${string}`;
+    tag: string;
+};
+export type ListTagRequest = {
+    options?: QueryOptions;
+};
+export type ListTagResponse = {
+    data: Tag[];
+};
+export type GetTagRequest = {
+    id: string;
+};
+export type GetTagResponse = {
+    data: Tag;
+};
+export type SetTagRequest = {
+    tag: string;
+    ipId: `0x${string}`;
+    txOptions?: TxOptions;
+};
+export type SetTagResponse = {
+    txHash: string;
+};
+export type RemoveTagRequest = {
+    tag: string;
+    ipId: `0x${string}`;
+    txOptions?: TxOptions;
+};
+export type RemoveTagResponse = {
+    txHash: string;
+};
+//# sourceMappingURL=tagging.d.ts.map

package/dist/declarations/src/types/resources/tagging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagging.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["tagging.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AAErD,MAAM,MAAM,GAAG,GAAG;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,GAAG,EAAE,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,GAAG,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/declarations/src/types/resources/transaction.d.ts

@@ -0,0 +1,52 @@
+import { ResourceType } from "../../enums/ResourceType.js";
+import { ActionType } from "../../enums/ActionType.js";
+import { QueryOptions } from "../options.js";
+/**
+ * Core data model for transactions.
+ *
+ * @public
+ */
+export type Transaction = {
+    id: string;
+    txHash: string;
+    ipOrgId: string;
+    initiator: string;
+    resourceId: string;
+    resourceType: ResourceType;
+    actionType: ActionType;
+    createdAt: string;
+};
+/**
+ * Request type for transaction.get method.
+ *
+ * @public
+ */
+export type GetTransactionRequest = {
+    transactionId: string;
+};
+/**
+ * Response type for transaction.get method.
+ *
+ * @public
+ */
+export type GetTransactionResponse = {
+    transaction: Transaction;
+};
+/**
+ * Response type for transaction.list method.
+ *
+ * @public
+ */
+export type ListTransactionRequest = {
+    ipOrgId?: string;
+    options?: QueryOptions;
+};
+/**
+ * Response type for transaction.list method.
+ *
+ * @public
+ */
+export type ListTransactionResponse = {
+    transactions: Transaction[];
+};
+//# sourceMappingURL=transaction.d.ts.map

package/dist/declarations/src/types/resources/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,oCAAiC;AACxD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,YAAY,EAAE,sBAAmB;AAE1C;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,YAAY,CAAC;IAC3B,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B,CAAC"}

package/dist/declarations/src/utils/platform.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+import { AxiosInstance } from "axios";
+export declare class PlatformClient {
+    protected readonly httpClient: AxiosInstance;
+    constructor(httpClient: AxiosInstance);
+    /**
+     * Upload a file to Arweave.
+     *
+     * @param file - the file binary data to upload
+     * @param mimeType - the mime type of the file
+     * @returns the response object that contains the uri of the uploaded file
+     */
+    uploadFile(file: File | Buffer, mimeType: string): Promise<{
+        uri: string;
+    }>;
+}
+//# sourceMappingURL=platform.d.ts.map

package/dist/declarations/src/utils/platform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.d.ts","sourceRoot":"../../../../src/utils","sources":["platform.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAItC,qBAAa,cAAc;IACzB,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;gBAEjC,UAAU,EAAE,aAAa;IAIrC;;;;;;OAMG;IACU,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CAyBzF"}

package/dist/story-protocol-core-sdk.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./declarations/src/index";
+//# sourceMappingURL=story-protocol-core-sdk.cjs.d.ts.map

package/dist/story-protocol-core-sdk.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"story-protocol-core-sdk.cjs.d.ts","sourceRoot":"","sources":["./declarations/src/index.d.ts"],"names":[],"mappings":"AAAA"}