@koralabs/kora-labs-common 1.1.2 → 1.2.0

package/lib/handles/interfaces.d.ts

@@ -0,0 +1,246 @@
+export declare enum Rarity {
+    basic = "basic",
+    common = "common",
+    rare = "rare",
+    ultra_rare = "ultra_rare",
+    legendary = "legendary"
+}
+export type BoolInt = 0 | 1;
+export type HexString = `0x${string}`;
+export type HexStringOrEmpty = HexString | '';
+/**
+ * The asset label is a string that is used to identify the asset type.
+ * First, remove the first and last 0.
+ * Next, use the first 4 characters as the hex and convert to decimal. https://www.rapidtables.com/convert/number/hex-to-decimal.html
+ * Finally, use the decimal number and convert to CRC8. It should match the last 2 characters. https://crccalc.com/
+ */
+export declare enum AssetNameLabel {
+    LABEL_100 = "000643b0",
+    LABEL_222 = "000de140",
+    LABEL_333 = "0014df10",
+    LABEL_444 = "001bc280"
+}
+export interface KeyPair {
+    key: string;
+    value: any;
+}
+export interface SocialItem {
+    display: string;
+    url: string;
+}
+interface ISharedPzDesigner {
+    pfp_border_color?: HexStringOrEmpty;
+    qr_inner_eye?: string;
+    qr_outer_eye?: string;
+    qr_dot?: string;
+    qr_bg_color?: HexStringOrEmpty;
+    qr_image?: string;
+    pfp_zoom?: number;
+    pfp_offset?: number[];
+    font?: string;
+    font_color?: HexStringOrEmpty;
+    font_shadow_size?: number[];
+    text_ribbon_colors?: HexStringOrEmpty[];
+    text_ribbon_gradient?: string;
+}
+export interface IPersonalizationDesigner extends ISharedPzDesigner {
+    font_shadow_color?: HexStringOrEmpty;
+    bg_color?: HexStringOrEmpty;
+    bg_border_color?: HexStringOrEmpty;
+    qr_link?: string;
+    socials?: SocialItem[];
+    creator_defaults_enabled?: BoolInt;
+}
+export interface ICreatorDefaults extends ISharedPzDesigner {
+    bg_border_colors?: HexStringOrEmpty[];
+    pfp_border_colors?: HexStringOrEmpty[];
+    font_shadow_colors?: HexStringOrEmpty[];
+    require_pfp_collections?: HexStringOrEmpty[];
+    require_pfp_attributes?: string[];
+    require_pfp_displayed?: BoolInt;
+    price?: number;
+    force_creator_settings?: BoolInt;
+    custom_dollar_symbol?: BoolInt;
+}
+export interface IPersonalizationPortal {
+    type: string;
+    domain?: string | null;
+    custom_settings?: string[] | null;
+}
+export interface ScriptDetails {
+    handle: string;
+    handleHex: string;
+    refScriptUtxo?: string;
+    refScriptAddress?: string;
+    cbor?: string;
+    unoptimizedCbor?: string;
+    validatorHash: string;
+    latest?: boolean;
+}
+export interface IReferenceToken {
+    tx_id: string;
+    index: number;
+    lovelace: number;
+    datum: string;
+    address: string;
+    script?: ScriptDetails;
+}
+export interface IPersonalization {
+    portal?: IPersonalizationPortal;
+    designer?: IPersonalizationDesigner;
+    socials?: SocialItem[];
+    validated_by: string;
+    trial: boolean;
+    nsfw: boolean;
+}
+export interface IHandle {
+    hex: string;
+    name: string;
+    image: string;
+    image_hash: string;
+    standard_image: string;
+    standard_image_hash: string;
+    pfp_image?: string;
+    pfp_asset?: string;
+    bg_image?: string;
+    bg_asset?: string;
+    holder: string;
+    holder_type: string;
+    length: number;
+    og_number: number;
+    rarity: Rarity;
+    characters: string;
+    numeric_modifiers: string;
+    default_in_wallet: string;
+    resolved_addresses: {
+        ada: string;
+        eth?: string;
+        btc?: string;
+    };
+    created_slot_number: number;
+    updated_slot_number: number;
+    utxo: string;
+    has_datum: boolean;
+    datum?: string;
+    script?: {
+        type: string;
+        cbor: string;
+    };
+    svg_version: string;
+    version: number;
+}
+export interface ICip68Handle extends IHandle {
+    reference_token?: IReferenceToken;
+}
+export interface IPersonalizedHandle extends ICip68Handle {
+    personalization?: IPersonalization;
+}
+export interface IHandleStats {
+    percentage_complete: string;
+    current_memory_used: number;
+    ogmios_elapsed: string;
+    building_elapsed: string;
+    handle_count: number;
+    slot_date: Date;
+    memory_size: number;
+    current_slot: number;
+    current_block_hash: string;
+    schema_version: number;
+}
+export interface IHandleMetadata {
+    name: string;
+    image: string;
+    mediaType: string;
+    og: BoolInt;
+    og_number: number;
+    rarity: string;
+    length: number;
+    characters: string;
+    numeric_modifiers: string;
+    version: number;
+}
+export interface IPzDatum {
+    standard_image: string;
+    image_hash: HexStringOrEmpty;
+    standard_image_hash: HexStringOrEmpty;
+    bg_image?: string;
+    pfp_image?: string;
+    pfp_asset?: HexStringOrEmpty;
+    bg_asset?: HexStringOrEmpty;
+    portal: string;
+    designer: string;
+    socials: string;
+    vendor: string;
+    default: BoolInt;
+    last_update_address: HexStringOrEmpty;
+    validated_by: HexStringOrEmpty;
+    trial: BoolInt;
+    nsfw: BoolInt;
+    svg_version: string;
+    agreed_terms: string;
+    migrate_sig_required: BoolInt;
+}
+export interface IHandleFileContent {
+    slot: number;
+    hash: string;
+    schemaVersion?: number;
+    handles: Record<string, IPersonalizedHandle>;
+}
+export interface IHandleSvgOptions extends IPersonalizationDesigner {
+    pfp_image?: string;
+    pfp_asset?: string;
+    bg_image?: string;
+    bg_asset?: string;
+    og_number?: number;
+}
+export interface PzSettings {
+    treasury_fee: number;
+    treasury_cred: HexStringOrEmpty;
+    pz_min_fee: number;
+    pz_providers: {
+        [pubKeyHashBytes: HexString]: HexStringOrEmpty;
+    };
+    valid_contracts: HexStringOrEmpty[];
+    admin_creds: HexStringOrEmpty[];
+    settings_cred: HexStringOrEmpty;
+}
+export interface ApprovedPolicies {
+    [policyId: HexString]: {
+        [patternMatch: HexString]: [number, number, number?];
+    };
+}
+export declare enum OAuthSocial {
+    'twitter' = 0,
+    'facebook' = 1,
+    'discord' = 2,
+    'instagram' = 3,
+    'tiktok' = 4,
+    'youtube' = 5,
+    'twitch' = 6,
+    'linkedin' = 7,
+    'snapchat' = 8,
+    'telegram' = 9,
+    'whatsapp' = 10,
+    'medium' = 11,
+    'github' = 12,
+    'reddit' = 13,
+    'pinterest' = 14,
+    'pin' = 15,
+    'spotify' = 16,
+    'soundcloud' = 17,
+    'paypal' = 18
+}
+export interface OAuthTokenMessage {
+    error?: string;
+    username?: string;
+    token?: string;
+    identifier?: string;
+    social: OAuthSocial;
+}
+export interface OAuthToken {
+    identifier: string;
+    username: string;
+    token: string;
+    social: OAuthSocial;
+}
+export {};

package/lib/handles/interfaces.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAuthSocial = exports.AssetNameLabel = exports.Rarity = void 0;
+var Rarity;
+(function (Rarity) {
+    Rarity["basic"] = "basic";
+    Rarity["common"] = "common";
+    Rarity["rare"] = "rare";
+    Rarity["ultra_rare"] = "ultra_rare";
+    Rarity["legendary"] = "legendary"; // - 1 character
+})(Rarity = exports.Rarity || (exports.Rarity = {}));
+/**
+ * The asset label is a string that is used to identify the asset type.
+ * First, remove the first and last 0.
+ * Next, use the first 4 characters as the hex and convert to decimal. https://www.rapidtables.com/convert/number/hex-to-decimal.html
+ * Finally, use the decimal number and convert to CRC8. It should match the last 2 characters. https://crccalc.com/
+ */
+var AssetNameLabel;
+(function (AssetNameLabel) {
+    AssetNameLabel["LABEL_100"] = "000643b0";
+    AssetNameLabel["LABEL_222"] = "000de140";
+    AssetNameLabel["LABEL_333"] = "0014df10";
+    AssetNameLabel["LABEL_444"] = "001bc280"; // 444
+})(AssetNameLabel = exports.AssetNameLabel || (exports.AssetNameLabel = {}));
+var OAuthSocial;
+(function (OAuthSocial) {
+    OAuthSocial[OAuthSocial["twitter"] = 0] = "twitter";
+    OAuthSocial[OAuthSocial["facebook"] = 1] = "facebook";
+    OAuthSocial[OAuthSocial["discord"] = 2] = "discord";
+    OAuthSocial[OAuthSocial["instagram"] = 3] = "instagram";
+    OAuthSocial[OAuthSocial["tiktok"] = 4] = "tiktok";
+    OAuthSocial[OAuthSocial["youtube"] = 5] = "youtube";
+    OAuthSocial[OAuthSocial["twitch"] = 6] = "twitch";
+    OAuthSocial[OAuthSocial["linkedin"] = 7] = "linkedin";
+    OAuthSocial[OAuthSocial["snapchat"] = 8] = "snapchat";
+    OAuthSocial[OAuthSocial["telegram"] = 9] = "telegram";
+    OAuthSocial[OAuthSocial["whatsapp"] = 10] = "whatsapp";
+    OAuthSocial[OAuthSocial["medium"] = 11] = "medium";
+    OAuthSocial[OAuthSocial["github"] = 12] = "github";
+    OAuthSocial[OAuthSocial["reddit"] = 13] = "reddit";
+    OAuthSocial[OAuthSocial["pinterest"] = 14] = "pinterest";
+    OAuthSocial[OAuthSocial["pin"] = 15] = "pin";
+    OAuthSocial[OAuthSocial["spotify"] = 16] = "spotify";
+    OAuthSocial[OAuthSocial["soundcloud"] = 17] = "soundcloud";
+    OAuthSocial[OAuthSocial["paypal"] = 18] = "paypal";
+})(OAuthSocial = exports.OAuthSocial || (exports.OAuthSocial = {}));

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 export { Logger, LogCategory } from "./logger";
 export { Environment, ComputeEnvironment } from "./environment";
+export * from "./handles/interfaces";
 export * from "./handles/constants";
 export { checkHandlePattern } from "./handles/validation";

package/lib/index.js

@@ -21,6 +21,7 @@ Object.defineProperty(exports, "LogCategory", { enumerable: true, get: function
 var environment_1 = require("./environment");
 Object.defineProperty(exports, "Environment", { enumerable: true, get: function () { return environment_1.Environment; } });
 Object.defineProperty(exports, "ComputeEnvironment", { enumerable: true, get: function () { return environment_1.ComputeEnvironment; } });
+__exportStar(require("./handles/interfaces"), exports);
 __exportStar(require("./handles/constants"), exports);
 var validation_1 = require("./handles/validation");
 Object.defineProperty(exports, "checkHandlePattern", { enumerable: true, get: function () { return validation_1.checkHandlePattern; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@koralabs/kora-labs-common",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Kora Labs Common Utilities",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",