@zoralabs/protocol-sdk 0.6.0 → 0.7.1

package/dist/ipfs/arweave.d.ts

@@ -0,0 +1,3 @@
+export type ArweaveURL = `ar://${string}`;
+export declare function isArweaveURL(url: string | null | undefined): boolean;
+//# sourceMappingURL=arweave.d.ts.map

package/dist/ipfs/arweave.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arweave.d.ts","sourceRoot":"","sources":["../../src/ipfs/arweave.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,QAAQ,MAAM,EAAE,CAAC;AAE1C,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAEpE"}

package/dist/ipfs/gateway.d.ts

@@ -0,0 +1,4 @@
+export declare function arweaveGatewayUrl(normalizedArweaveUrl: string | null): string | null;
+export declare function ipfsGatewayUrl(url: string | null): string | null;
+export declare function getFetchableUrl(uri: string | null | undefined): string | null;
+//# sourceMappingURL=gateway.d.ts.map

package/dist/ipfs/gateway.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gateway.d.ts","sourceRoot":"","sources":["../../src/ipfs/gateway.ts"],"names":[],"mappings":"AAOA,wBAAgB,iBAAiB,CAAC,oBAAoB,EAAE,MAAM,GAAG,IAAI,iBAIpE;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,iBAOhD;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,CAyB7E"}

package/dist/ipfs/index.d.ts

@@ -0,0 +1,4 @@
+export { makeMediaTokenMetadata, makeTextTokenMetadata, } from "./token-metadata";
+export { generateTextNftMetadataFiles } from "./text-metadata";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/ipfs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ipfs/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AAE/D,cAAc,SAAS,CAAC"}

package/dist/ipfs/ipfs.d.ts

@@ -0,0 +1,5 @@
+export type IPFSUrl = `ipfs://${string}`;
+export declare function isCID(str: string | null | undefined): boolean;
+export declare function normalizeIPFSUrl(url: string | null | undefined): IPFSUrl | null;
+export declare function isNormalizeableIPFSUrl(url: string | null | undefined): boolean;
+//# sourceMappingURL=ipfs.d.ts.map

package/dist/ipfs/ipfs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfs.d.ts","sourceRoot":"","sources":["../../src/ipfs/ipfs.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,OAAO,GAAG,UAAU,MAAM,EAAE,CAAC;AAEzC,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAU7D;AAED,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAC7B,OAAO,GAAG,IAAI,CAgChB;AA2BD,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAC7B,OAAO,CAET"}

package/dist/ipfs/mimeTypes.d.ts

@@ -0,0 +1,25 @@
+export declare const TEXT_PLAIN = "text/plain";
+export declare const isImage: (mimeType: string | null | undefined) => boolean;
+export declare enum MediaType {
+    CSV = "CSV",
+    NUMBERS = "NUMBERS",
+    EXCEL = "EXCEL",
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO",
+    AUDIO = "AUDIO",
+    TIFF = "TIFF",
+    TEXT = "TEXT",
+    PDF = "PDF",
+    MODEL = "MODEL",
+    HTML = "HTML",
+    ZIP = "ZIP",
+    UNKNOWN = "UNKNOWN"
+}
+export declare const DEFAULT_THUMBNAIL_CID_HASHES: {
+    [key: string]: string;
+};
+export declare const JSON_MIME_TYPE = "application/json";
+/** Return a MediaType for the given mime type. If mime type is unknown you can provide a filename as a fallback, where the type will be guessed based on extension. */
+export declare function mimeTypeToMedia(mimeType?: string | null): MediaType;
+export declare function getMimeType(uri?: string): Promise<string | null | undefined>;
+//# sourceMappingURL=mimeTypes.d.ts.map

package/dist/ipfs/mimeTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mimeTypes.d.ts","sourceRoot":"","sources":["../../src/ipfs/mimeTypes.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,UAAU,eAAe,CAAC;AAevC,eAAO,MAAM,OAAO,aAAc,MAAM,GAAG,IAAI,GAAG,SAAS,YAG1D,CAAC;AAEF,oBAAY,SAAS;IACnB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,4BAA4B,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAYjE,CAAC;AA2BF,eAAO,MAAM,cAAc,qBAAqB,CAAC;AA4CjD,uKAAuK;AACvK,wBAAgB,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,aAOvD;AAED,wBAAsB,WAAW,CAAC,GAAG,CAAC,EAAE,MAAM,sCAM7C"}

package/dist/ipfs/text-metadata.d.ts

@@ -0,0 +1,5 @@
+import { TextMetadataFiles } from "./types";
+/** For text nfts, this will generate files that are needed for the metadata json, including the txt.file containing the text, and a thumbnail image containing a preview of the text
+ */
+export declare function generateTextNftMetadataFiles(text: string): Promise<TextMetadataFiles>;
+//# sourceMappingURL=text-metadata.d.ts.map

package/dist/ipfs/text-metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-metadata.d.ts","sourceRoot":"","sources":["../../src/ipfs/text-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAiH5C;GACG;AACH,wBAAsB,4BAA4B,CAChD,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,iBAAiB,CAAC,CAU5B"}

package/dist/ipfs/token-metadata.d.ts

@@ -0,0 +1,14 @@
+import { MakeMediaMetadataParams, MakeTextMetadataParams, TokenMetadataJson } from "./types";
+/**
+ * Takes properties for a text based nft and formats it as proper json metadata
+ * for the token, which should be uploaded to IPFS.
+ * @param parameters - The parameters to format into metadata {@link MakeTextMetadataParams}
+ */
+export declare const makeTextTokenMetadata: (parameters: MakeTextMetadataParams) => TokenMetadataJson;
+/**
+ * Takes properties for a media based nft (video, image, etc) and formats it as proper json metadata
+ * for the token, which should be uploaded to IPFS.
+ * @param parameters - The parameters to format into metadata {@link MakeMediaMetadataParams}
+ */
+export declare const makeMediaTokenMetadata: ({ name, description, attributes, mediaUrl, thumbnailUrl, }: MakeMediaMetadataParams) => Promise<TokenMetadataJson>;
+//# sourceMappingURL=token-metadata.d.ts.map

package/dist/ipfs/token-metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-metadata.d.ts","sourceRoot":"","sources":["../../src/ipfs/token-metadata.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,eACpB,sBAAsB,KACjC,iBAoBF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,+DAMhC,uBAAuB,KAAG,QAAQ,iBAAiB,CA4CrD,CAAC"}

package/dist/ipfs/types.d.ts

@@ -0,0 +1,49 @@
+export type CreateERC1155TokenAttributes = {
+    trait_type: string;
+    value: string;
+};
+export type ContractMetadataJson = {
+    name?: string;
+    description?: string;
+    image?: string;
+};
+export type TokenMetadataJson = {
+    name: string;
+    description?: string;
+    /** Primary image file */
+    image?: string;
+    animation_url?: string | null;
+    content?: {
+        mime: string;
+        uri: string;
+    } | null;
+    attributes: Array<CreateERC1155TokenAttributes>;
+};
+export type BaseMetadataParams = {
+    /** Token name */
+    name: string;
+    /** Optional description */
+    description?: string;
+    /** Optional attributes to tag the token with */
+    attributes?: CreateERC1155TokenAttributes[];
+};
+export type MakeTextMetadataParams = BaseMetadataParams & {
+    /** Ipfs url where media is hosted */
+    textFileUrl: string;
+    /** If thumbnail was generate for text file, thumbnail image url */
+    thumbnailUrl?: string;
+};
+export type TextMetadataFiles = {
+    name: string;
+    /** File that holds the text, and is the primary media */
+    mediaUrlFile: File;
+    /** Thumbnail image preview of the text */
+    thumbnailFile: File;
+};
+export type MakeMediaMetadataParams = BaseMetadataParams & {
+    /** Ipfs url where media is hosted */
+    mediaUrl: string;
+    /** Ipfs url where thumbnail of media is hosted */
+    thumbnailUrl?: string;
+};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/ipfs/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,4BAA4B,GAAG;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yBAAyB;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,OAAO,CAAC,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;KACb,GAAG,IAAI,CAAC;IACT,UAAU,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,UAAU,CAAC,EAAE,4BAA4B,EAAE,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,GAAG;IACxD,qCAAqC;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,yDAAyD;IACzD,YAAY,EAAE,IAAI,CAAC;IACnB,0CAA0C;IAC1C,aAAa,EAAE,IAAI,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,kBAAkB,GAAG;IACzD,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,kDAAkD;IAClD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC"}