@vskin/sdk 0.1.0

package/dist/interfaces-OatKvSe8.d.cts

@@ -0,0 +1,281 @@
+declare enum EView {
+    FREE = "free",
+    FIRST_PERSON = "firstPerson",
+    THIRD_PERSON = "thirdPerson"
+}
+declare enum EBackgroundType {
+    NONE = "none",
+    ENVIRONMENT = "environment"
+}
+type Background = {
+    type: EBackgroundType;
+};
+declare enum EFacing {
+    FRONT = "front",
+    BACK = "back"
+}
+declare enum EHandedness {
+    RIGHT = "right",
+    LEFT = "left"
+}
+declare enum ESubject {
+    WEAPON = "weapon",
+    GLOVES = "gloves"
+}
+type Weapon = {
+    cert?: string;
+    defIndex?: number;
+    paintIndex?: number;
+    seed?: number;
+    float?: number;
+    stattrak?: boolean;
+    kills?: number;
+    name?: string;
+};
+type Gloves = {
+    cert?: string;
+    defIndex?: number;
+    paintIndex?: number;
+    seed?: number;
+    float?: number;
+};
+type Agent = {
+    cert?: string;
+    defIndex?: number;
+};
+type Sticker = {
+    id: number;
+    slot: number;
+    wear?: number;
+    rotation?: number;
+    offsetX?: number;
+    offsetY?: number;
+};
+type Charm = {
+    id: number;
+    pattern?: number;
+    wrappedSticker?: number;
+    offsetX?: number;
+    offsetY?: number;
+    offsetZ?: number;
+};
+type Patch = {
+    id: number;
+    slot: number;
+};
+type FirstPersonSettings = {
+    fov?: number;
+    offsetX?: number;
+    offsetY?: number;
+    offsetZ?: number;
+    handedness?: EHandedness;
+};
+type FocusTarget = {
+    kind: 'sticker';
+    uid: string;
+} | {
+    kind: 'charm';
+} | {
+    kind: 'patch';
+    slot: number;
+} | null;
+type PlacementTarget = {
+    kind: 'sticker';
+    slot: number;
+} | {
+    kind: 'charm';
+} | null;
+type Capability = {
+    entitled: boolean;
+    available: boolean;
+};
+declare enum EFeature {
+    SELECT_WEAPON = "selectWeapon",
+    SELECT_GLOVES = "selectGloves",
+    SELECT_AGENT = "selectAgent",
+    SELECT_ENVIRONMENT = "selectEnvironment",
+    EDIT_SEED = "editSeed",
+    EDIT_FLOAT = "editFloat",
+    EDIT_STATTRAK = "editStattrak",
+    EDIT_NAMETAG = "editNametag",
+    SELECT_STICKER = "selectSticker",
+    SELECT_CHARM = "selectCharm",
+    SELECT_PATCH = "selectPatch",
+    EDIT_STICKERS = "editStickers",
+    EDIT_CHARMS = "editCharms",
+    PLACE_STICKERS = "placeStickers",
+    PLACE_CHARM = "placeCharm",
+    SCREENSHOT = "screenshot",
+    INSPECT_LINK = "inspectLink",
+    SUBJECT_CONTROLS = "subjectControls",
+    WEAPON_ANIMATIONS = "weaponAnimations",
+    AGENT_ANIMATIONS = "agentAnimations"
+}
+type ViewerCapabilities = {
+    views: Record<EView, Capability>;
+    features: Record<EFeature, Capability>;
+};
+type AnimationEntry = {
+    name: string;
+    loop: boolean;
+};
+type ViewerState = {
+    weapon: Weapon | null;
+    gloves: Gloves | null;
+    agent: Agent | null;
+    subject: ESubject | null;
+    view: {
+        view: EView;
+        active: boolean;
+    };
+    environment: string | null;
+    background: Background;
+    stickers: Array<Sticker & {
+        uid?: string;
+    }>;
+    charm: Charm | null;
+    charmAnchor: [number, number, number] | null;
+    patches: Array<Patch>;
+    patchSlots: number | null;
+    playing: boolean;
+    animation: string | null;
+    animations: Array<AnimationEntry>;
+    agentAnimation: string | null;
+    agentAnimations: Array<string>;
+    sound: {
+        muted: boolean;
+    };
+    firstPerson: FirstPersonSettings;
+    facing: EFacing;
+    placement: PlacementTarget;
+};
+
+declare enum EErrorCode {
+    INVALID_KEY = "invalid_key",
+    ORIGIN_NOT_ALLOWED = "origin_not_allowed",
+    NOT_ENTITLED = "not_entitled",
+    UNSUPPORTED_VIEW = "unsupported_view",
+    UNAVAILABLE_ITEM = "unavailable_item",
+    INVALID_ARGUMENT = "invalid_argument",
+    NOT_READY = "not_ready",
+    RATE_LIMITED = "rate_limited",
+    INTERNAL = "internal"
+}
+declare enum EViewerEvent {
+    READY = "ready",
+    ERROR = "error",
+    RECONNECT = "reconnect",
+    PROGRESS = "progress",
+    UNAVAILABLE = "unavailable",
+    CHANGE = "change",
+    VIEW_CHANGE = "viewchange",
+    SUBJECT_CHANGE = "subjectchange",
+    COSMETICS_CHANGE = "cosmeticschange",
+    ANIMATION_CHANGE = "animationchange",
+    PLAYBACK_CHANGE = "playbackchange",
+    CAPABILITIES_CHANGE = "capabilitieschange",
+    PLACEMENT_START = "placementstart",
+    PLACEMENT_MOVE = "placementmove",
+    PLACEMENT_END = "placementend"
+}
+type ViewerError = {
+    code: EErrorCode;
+    message?: string;
+};
+
+type CatalogQuery = {
+    search?: string;
+    limit?: number;
+    offset?: number;
+    [key: string]: unknown;
+};
+type ViewerEventHandler = (payload: unknown) => void;
+type Viewer = {
+    readonly state: ViewerState;
+    readonly capabilities: ViewerCapabilities;
+    on: (event: EViewerEvent | `${EViewerEvent}`, handler: ViewerEventHandler) => () => void;
+    setWeapon: (args: {
+        weapon: Weapon | null;
+    }) => Promise<void>;
+    setGloves: (args: {
+        gloves: Gloves | null;
+    }) => Promise<void>;
+    setAgent: (args: {
+        agent: Agent | null;
+    }) => Promise<void>;
+    setSubject: (args: {
+        subject: ESubject | `${ESubject}`;
+    }) => Promise<void>;
+    setStickers: (args: {
+        stickers: Array<Sticker>;
+    }) => Promise<void>;
+    setCharm: (args: {
+        charm: Charm | null;
+    }) => Promise<void>;
+    setPatches: (args: {
+        patches: Array<Patch>;
+    }) => Promise<void>;
+    setView: (args: {
+        view: EView | `${EView}`;
+    }) => Promise<void>;
+    setFirstPersonSettings: (args: FirstPersonSettings) => Promise<void>;
+    setFacing: (args: {
+        facing: EFacing | `${EFacing}`;
+    }) => Promise<void>;
+    setEnvironment: (args: {
+        environment: string | null;
+    }) => Promise<void>;
+    setBackground: (args: {
+        background: Background;
+    }) => Promise<void>;
+    setSound: (args: {
+        muted: boolean;
+    }) => Promise<void>;
+    setLocale: (args: {
+        locale: string;
+    }) => Promise<void>;
+    focus: (args: {
+        target: FocusTarget;
+    }) => Promise<void>;
+    resetCamera: () => Promise<void>;
+    play: () => Promise<void>;
+    pause: () => Promise<void>;
+    playAnimation: (args: {
+        name: string;
+    }) => Promise<void>;
+    stopAnimation: () => Promise<void>;
+    startFire: () => Promise<void>;
+    stopFire: () => Promise<void>;
+    armPlacement: (args: {
+        target: PlacementTarget;
+    }) => Promise<void>;
+    forwardPointer: (args: {
+        x: number;
+        y: number;
+        phase: 'start' | 'move' | 'end';
+    }) => Promise<void>;
+    capture: () => Promise<string>;
+    catalog: {
+        weapons: (query?: CatalogQuery) => Promise<unknown>;
+        stickers: (query?: CatalogQuery) => Promise<unknown>;
+        charms: (query?: CatalogQuery) => Promise<unknown>;
+        patches: (query?: CatalogQuery) => Promise<unknown>;
+        agents: (query?: CatalogQuery) => Promise<unknown>;
+        weaponModels: () => Promise<unknown>;
+        environments: () => Promise<unknown>;
+    };
+    destroy: () => void;
+};
+type CreateViewerOptions = {
+    container: HTMLElement;
+    key?: string;
+    baseUrl?: string;
+    weapon?: Weapon;
+    environment?: string;
+    background?: Background;
+    interactive?: boolean;
+    autoplay?: boolean;
+    locale?: string;
+};
+
+export { type Agent as A, type Background as B, type CreateViewerOptions as C, EBackgroundType as E, type FirstPersonSettings as F, type Gloves as G, type Patch as P, type Sticker as S, type Viewer as V, type Weapon as W, type AnimationEntry as a, type Capability as b, type CatalogQuery as c, type Charm as d, EErrorCode as e, EFacing as f, EFeature as g, EHandedness as h, ESubject as i, EView as j, EViewerEvent as k, type FocusTarget as l, type PlacementTarget as m, type ViewerCapabilities as n, type ViewerError as o, type ViewerEventHandler as p, type ViewerState as q };

package/dist/interfaces-OatKvSe8.d.ts

@@ -0,0 +1,281 @@
+declare enum EView {
+    FREE = "free",
+    FIRST_PERSON = "firstPerson",
+    THIRD_PERSON = "thirdPerson"
+}
+declare enum EBackgroundType {
+    NONE = "none",
+    ENVIRONMENT = "environment"
+}
+type Background = {
+    type: EBackgroundType;
+};
+declare enum EFacing {
+    FRONT = "front",
+    BACK = "back"
+}
+declare enum EHandedness {
+    RIGHT = "right",
+    LEFT = "left"
+}
+declare enum ESubject {
+    WEAPON = "weapon",
+    GLOVES = "gloves"
+}
+type Weapon = {
+    cert?: string;
+    defIndex?: number;
+    paintIndex?: number;
+    seed?: number;
+    float?: number;
+    stattrak?: boolean;
+    kills?: number;
+    name?: string;
+};
+type Gloves = {
+    cert?: string;
+    defIndex?: number;
+    paintIndex?: number;
+    seed?: number;
+    float?: number;
+};
+type Agent = {
+    cert?: string;
+    defIndex?: number;
+};
+type Sticker = {
+    id: number;
+    slot: number;
+    wear?: number;
+    rotation?: number;
+    offsetX?: number;
+    offsetY?: number;
+};
+type Charm = {
+    id: number;
+    pattern?: number;
+    wrappedSticker?: number;
+    offsetX?: number;
+    offsetY?: number;
+    offsetZ?: number;
+};
+type Patch = {
+    id: number;
+    slot: number;
+};
+type FirstPersonSettings = {
+    fov?: number;
+    offsetX?: number;
+    offsetY?: number;
+    offsetZ?: number;
+    handedness?: EHandedness;
+};
+type FocusTarget = {
+    kind: 'sticker';
+    uid: string;
+} | {
+    kind: 'charm';
+} | {
+    kind: 'patch';
+    slot: number;
+} | null;
+type PlacementTarget = {
+    kind: 'sticker';
+    slot: number;
+} | {
+    kind: 'charm';
+} | null;
+type Capability = {
+    entitled: boolean;
+    available: boolean;
+};
+declare enum EFeature {
+    SELECT_WEAPON = "selectWeapon",
+    SELECT_GLOVES = "selectGloves",
+    SELECT_AGENT = "selectAgent",
+    SELECT_ENVIRONMENT = "selectEnvironment",
+    EDIT_SEED = "editSeed",
+    EDIT_FLOAT = "editFloat",
+    EDIT_STATTRAK = "editStattrak",
+    EDIT_NAMETAG = "editNametag",
+    SELECT_STICKER = "selectSticker",
+    SELECT_CHARM = "selectCharm",
+    SELECT_PATCH = "selectPatch",
+    EDIT_STICKERS = "editStickers",
+    EDIT_CHARMS = "editCharms",
+    PLACE_STICKERS = "placeStickers",
+    PLACE_CHARM = "placeCharm",
+    SCREENSHOT = "screenshot",
+    INSPECT_LINK = "inspectLink",
+    SUBJECT_CONTROLS = "subjectControls",
+    WEAPON_ANIMATIONS = "weaponAnimations",
+    AGENT_ANIMATIONS = "agentAnimations"
+}
+type ViewerCapabilities = {
+    views: Record<EView, Capability>;
+    features: Record<EFeature, Capability>;
+};
+type AnimationEntry = {
+    name: string;
+    loop: boolean;
+};
+type ViewerState = {
+    weapon: Weapon | null;
+    gloves: Gloves | null;
+    agent: Agent | null;
+    subject: ESubject | null;
+    view: {
+        view: EView;
+        active: boolean;
+    };
+    environment: string | null;
+    background: Background;
+    stickers: Array<Sticker & {
+        uid?: string;
+    }>;
+    charm: Charm | null;
+    charmAnchor: [number, number, number] | null;
+    patches: Array<Patch>;
+    patchSlots: number | null;
+    playing: boolean;
+    animation: string | null;
+    animations: Array<AnimationEntry>;
+    agentAnimation: string | null;
+    agentAnimations: Array<string>;
+    sound: {
+        muted: boolean;
+    };
+    firstPerson: FirstPersonSettings;
+    facing: EFacing;
+    placement: PlacementTarget;
+};
+
+declare enum EErrorCode {
+    INVALID_KEY = "invalid_key",
+    ORIGIN_NOT_ALLOWED = "origin_not_allowed",
+    NOT_ENTITLED = "not_entitled",
+    UNSUPPORTED_VIEW = "unsupported_view",
+    UNAVAILABLE_ITEM = "unavailable_item",
+    INVALID_ARGUMENT = "invalid_argument",
+    NOT_READY = "not_ready",
+    RATE_LIMITED = "rate_limited",
+    INTERNAL = "internal"
+}
+declare enum EViewerEvent {
+    READY = "ready",
+    ERROR = "error",
+    RECONNECT = "reconnect",
+    PROGRESS = "progress",
+    UNAVAILABLE = "unavailable",
+    CHANGE = "change",
+    VIEW_CHANGE = "viewchange",
+    SUBJECT_CHANGE = "subjectchange",
+    COSMETICS_CHANGE = "cosmeticschange",
+    ANIMATION_CHANGE = "animationchange",
+    PLAYBACK_CHANGE = "playbackchange",
+    CAPABILITIES_CHANGE = "capabilitieschange",
+    PLACEMENT_START = "placementstart",
+    PLACEMENT_MOVE = "placementmove",
+    PLACEMENT_END = "placementend"
+}
+type ViewerError = {
+    code: EErrorCode;
+    message?: string;
+};
+
+type CatalogQuery = {
+    search?: string;
+    limit?: number;
+    offset?: number;
+    [key: string]: unknown;
+};
+type ViewerEventHandler = (payload: unknown) => void;
+type Viewer = {
+    readonly state: ViewerState;
+    readonly capabilities: ViewerCapabilities;
+    on: (event: EViewerEvent | `${EViewerEvent}`, handler: ViewerEventHandler) => () => void;
+    setWeapon: (args: {
+        weapon: Weapon | null;
+    }) => Promise<void>;
+    setGloves: (args: {
+        gloves: Gloves | null;
+    }) => Promise<void>;
+    setAgent: (args: {
+        agent: Agent | null;
+    }) => Promise<void>;
+    setSubject: (args: {
+        subject: ESubject | `${ESubject}`;
+    }) => Promise<void>;
+    setStickers: (args: {
+        stickers: Array<Sticker>;
+    }) => Promise<void>;
+    setCharm: (args: {
+        charm: Charm | null;
+    }) => Promise<void>;
+    setPatches: (args: {
+        patches: Array<Patch>;
+    }) => Promise<void>;
+    setView: (args: {
+        view: EView | `${EView}`;
+    }) => Promise<void>;
+    setFirstPersonSettings: (args: FirstPersonSettings) => Promise<void>;
+    setFacing: (args: {
+        facing: EFacing | `${EFacing}`;
+    }) => Promise<void>;
+    setEnvironment: (args: {
+        environment: string | null;
+    }) => Promise<void>;
+    setBackground: (args: {
+        background: Background;
+    }) => Promise<void>;
+    setSound: (args: {
+        muted: boolean;
+    }) => Promise<void>;
+    setLocale: (args: {
+        locale: string;
+    }) => Promise<void>;
+    focus: (args: {
+        target: FocusTarget;
+    }) => Promise<void>;
+    resetCamera: () => Promise<void>;
+    play: () => Promise<void>;
+    pause: () => Promise<void>;
+    playAnimation: (args: {
+        name: string;
+    }) => Promise<void>;
+    stopAnimation: () => Promise<void>;
+    startFire: () => Promise<void>;
+    stopFire: () => Promise<void>;
+    armPlacement: (args: {
+        target: PlacementTarget;
+    }) => Promise<void>;
+    forwardPointer: (args: {
+        x: number;
+        y: number;
+        phase: 'start' | 'move' | 'end';
+    }) => Promise<void>;
+    capture: () => Promise<string>;
+    catalog: {
+        weapons: (query?: CatalogQuery) => Promise<unknown>;
+        stickers: (query?: CatalogQuery) => Promise<unknown>;
+        charms: (query?: CatalogQuery) => Promise<unknown>;
+        patches: (query?: CatalogQuery) => Promise<unknown>;
+        agents: (query?: CatalogQuery) => Promise<unknown>;
+        weaponModels: () => Promise<unknown>;
+        environments: () => Promise<unknown>;
+    };
+    destroy: () => void;
+};
+type CreateViewerOptions = {
+    container: HTMLElement;
+    key?: string;
+    baseUrl?: string;
+    weapon?: Weapon;
+    environment?: string;
+    background?: Background;
+    interactive?: boolean;
+    autoplay?: boolean;
+    locale?: string;
+};
+
+export { type Agent as A, type Background as B, type CreateViewerOptions as C, EBackgroundType as E, type FirstPersonSettings as F, type Gloves as G, type Patch as P, type Sticker as S, type Viewer as V, type Weapon as W, type AnimationEntry as a, type Capability as b, type CatalogQuery as c, type Charm as d, EErrorCode as e, EFacing as f, EFeature as g, EHandedness as h, ESubject as i, EView as j, EViewerEvent as k, type FocusTarget as l, type PlacementTarget as m, type ViewerCapabilities as n, type ViewerError as o, type ViewerEventHandler as p, type ViewerState as q };