@humation/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,699 @@
+type HexColor = string;
+type CropId = 'avatar' | 'full';
+type Background = HexColor | 'transparent';
+type HumationClientOptions = {
+    baseUrl?: string;
+    apiKey?: string;
+    fetch?: typeof fetch;
+    headers?: HeadersInit;
+};
+type TemplateSummary = {
+    id: string;
+    name: string;
+    author: {
+        name: string;
+        url?: string;
+    };
+    templateUrl: string;
+    assetsUrl: string;
+    renderSvgUrl: string;
+};
+type TemplatePart = {
+    id: string;
+    label?: string;
+};
+type TemplateGroup = {
+    id: string;
+    label: string;
+    control?: 'select' | 'toggle';
+    hidden?: boolean;
+    defaultPart: string;
+    onPart?: string;
+    offPart?: string;
+    parts: TemplatePart[];
+    layerOrder: number;
+    offset: {
+        x: number;
+        y: number;
+    };
+    size: {
+        width: number;
+        height: number;
+    };
+    links?: Array<{
+        targetGroupId: string;
+        behavior: 'mirror_selection';
+    }>;
+};
+type TemplateColorOption = {
+    id: string;
+    label: string;
+    default: HexColor;
+};
+type TemplateCropOption = {
+    id: CropId;
+    mode: 'bounds' | 'square_from_bounds' | 'view_box';
+    paddingRatio?: number;
+    viewBox?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+};
+type AvatarTemplate = {
+    id: string;
+    name: string;
+    author: {
+        name: string;
+        url?: string;
+    };
+    groups: TemplateGroup[];
+    colorOptions: TemplateColorOption[];
+    cropOptions: TemplateCropOption[];
+    defaultCrop: CropId;
+    renderSvgUrl: string;
+};
+type AvatarAsset = {
+    groupId: string;
+    partId: string;
+    svg: string;
+};
+type AvatarAssetsResponse = AvatarTemplate & {
+    assets: AvatarAsset[];
+};
+type AvatarState = {
+    templateId: string;
+    parts: Record<string, string>;
+    colors: Record<string, HexColor>;
+    background: Background;
+    crop: CropId;
+};
+type LoadAvatarOptions = {
+    state?: Partial<AvatarState>;
+};
+
+declare class AvatarSession {
+    readonly template: AvatarAssetsResponse;
+    private readonly assets;
+    private readonly baseUrl;
+    private state;
+    constructor(template: AvatarAssetsResponse, baseUrl: string, state?: Partial<AvatarState>);
+    getState(): AvatarState;
+    toJSON(): AvatarState;
+    getGroups(options?: {
+        includeHidden?: boolean;
+    }): TemplateGroup[];
+    getParts(groupId: string): TemplatePart[];
+    getColors(): TemplateColorOption[];
+    setPart(groupId: string, partId: string): this;
+    setColor(colorId: string, color: string): this;
+    setBackground(background: Background): this;
+    setCrop(crop: CropId): this;
+    toSvg(): string;
+    toPngBlob(): Promise<Blob>;
+    renderUrl(): string;
+    private getGroup;
+    private normalizePartValue;
+    private resolveLinkedSelections;
+    private buildRenderLayers;
+    private resolveViewBox;
+    private getBounds;
+    private findAsset;
+}
+
+declare class HumationClient {
+    readonly baseUrl: string;
+    private readonly apiKey?;
+    private readonly fetcher;
+    private readonly headers?;
+    constructor(options?: HumationClientOptions);
+    listTemplates(): Promise<TemplateSummary[]>;
+    getTemplate(templateId: string): Promise<AvatarTemplate>;
+    getTemplateAssets(templateId: string): Promise<AvatarAssetsResponse>;
+    loadAvatar(templateId: string, options?: LoadAvatarOptions): Promise<AvatarSession>;
+    renderUrl(templateId: string): string;
+    private requestJson;
+    private buildHeaders;
+}
+declare function createHumationClient(options?: HumationClientOptions): HumationClient;
+
+declare class HumationApiError extends Error {
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: unknown;
+    constructor(response: Response, body?: unknown);
+}
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetHealth200Status = (typeof GetHealth200Status)[keyof typeof GetHealth200Status];
+declare const GetHealth200Status: {
+    readonly ok: "ok";
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+type GetHealth200 = {
+    status: GetHealth200Status;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplate200Author = {
+    name: string;
+    url?: string;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplate200ColorOptionsItem = {
+    /** @minLength 1 */
+    id: string;
+    /** @minLength 1 */
+    label: string;
+    /** @pattern ^[0-9a-fA-F]{6}$ */
+    default: string;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplate200CropOptionsItemId = (typeof GetTemplate200CropOptionsItemId)[keyof typeof GetTemplate200CropOptionsItemId];
+declare const GetTemplate200CropOptionsItemId: {
+    readonly avatar: "avatar";
+    readonly full: "full";
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplate200CropOptionsItemMode = (typeof GetTemplate200CropOptionsItemMode)[keyof typeof GetTemplate200CropOptionsItemMode];
+declare const GetTemplate200CropOptionsItemMode: {
+    readonly bounds: "bounds";
+    readonly square_from_bounds: "square_from_bounds";
+    readonly view_box: "view_box";
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplate200CropOptionsItemViewBox = {
+    x: number;
+    y: number;
+    /** @exclusiveMinimum 0 */
+    width: number;
+    /** @exclusiveMinimum 0 */
+    height: number;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+type GetTemplate200CropOptionsItem = {
+    id: GetTemplate200CropOptionsItemId;
+    mode: GetTemplate200CropOptionsItemMode;
+    /** @minimum 0 */
+    paddingRatio?: number;
+    viewBox?: GetTemplate200CropOptionsItemViewBox;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplate200DefaultCrop = (typeof GetTemplate200DefaultCrop)[keyof typeof GetTemplate200DefaultCrop];
+declare const GetTemplate200DefaultCrop: {
+    readonly avatar: "avatar";
+    readonly full: "full";
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplate200GroupsItemControl = (typeof GetTemplate200GroupsItemControl)[keyof typeof GetTemplate200GroupsItemControl];
+declare const GetTemplate200GroupsItemControl: {
+    readonly select: "select";
+    readonly toggle: "toggle";
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplate200GroupsItemOffset = {
+    x: number;
+    y: number;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplate200GroupsItemPartsItem = {
+    /** @minLength 1 */
+    id: string;
+    label?: string;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplate200GroupsItemSize = {
+    /** @exclusiveMinimum 0 */
+    width: number;
+    /** @exclusiveMinimum 0 */
+    height: number;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+type GetTemplate200GroupsItem = {
+    /** @minLength 1 */
+    id: string;
+    /** @minLength 1 */
+    label: string;
+    control?: GetTemplate200GroupsItemControl;
+    /** @minLength 1 */
+    defaultPart: string;
+    /** @minLength 1 */
+    onPart?: string;
+    /** @minLength 1 */
+    offPart?: string;
+    /** @minItems 1 */
+    parts: GetTemplate200GroupsItemPartsItem[];
+    layerOrder: number;
+    offset: GetTemplate200GroupsItemOffset;
+    size: GetTemplate200GroupsItemSize;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+type GetTemplate200 = {
+    id: string;
+    name: string;
+    author: GetTemplate200Author;
+    groups: GetTemplate200GroupsItem[];
+    colorOptions: GetTemplate200ColorOptionsItem[];
+    cropOptions: GetTemplate200CropOptionsItem[];
+    defaultCrop: GetTemplate200DefaultCrop;
+    renderSvgUrl: string;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200AssetsItem = {
+    groupId: string;
+    partId: string;
+    svg: string;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200Author = {
+    name: string;
+    url?: string;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200ColorOptionsItem = {
+    /** @minLength 1 */
+    id: string;
+    /** @minLength 1 */
+    label: string;
+    /** @pattern ^[0-9a-fA-F]{6}$ */
+    default: string;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200CropOptionsItemId = (typeof GetTemplateAssets200CropOptionsItemId)[keyof typeof GetTemplateAssets200CropOptionsItemId];
+declare const GetTemplateAssets200CropOptionsItemId: {
+    readonly avatar: "avatar";
+    readonly full: "full";
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200CropOptionsItemMode = (typeof GetTemplateAssets200CropOptionsItemMode)[keyof typeof GetTemplateAssets200CropOptionsItemMode];
+declare const GetTemplateAssets200CropOptionsItemMode: {
+    readonly bounds: "bounds";
+    readonly square_from_bounds: "square_from_bounds";
+    readonly view_box: "view_box";
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200CropOptionsItemViewBox = {
+    x: number;
+    y: number;
+    /** @exclusiveMinimum 0 */
+    width: number;
+    /** @exclusiveMinimum 0 */
+    height: number;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+type GetTemplateAssets200CropOptionsItem = {
+    id: GetTemplateAssets200CropOptionsItemId;
+    mode: GetTemplateAssets200CropOptionsItemMode;
+    /** @minimum 0 */
+    paddingRatio?: number;
+    viewBox?: GetTemplateAssets200CropOptionsItemViewBox;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200DefaultCrop = (typeof GetTemplateAssets200DefaultCrop)[keyof typeof GetTemplateAssets200DefaultCrop];
+declare const GetTemplateAssets200DefaultCrop: {
+    readonly avatar: "avatar";
+    readonly full: "full";
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200GroupsItemControl = (typeof GetTemplateAssets200GroupsItemControl)[keyof typeof GetTemplateAssets200GroupsItemControl];
+declare const GetTemplateAssets200GroupsItemControl: {
+    readonly select: "select";
+    readonly toggle: "toggle";
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200GroupsItemLinksItemBehavior = (typeof GetTemplateAssets200GroupsItemLinksItemBehavior)[keyof typeof GetTemplateAssets200GroupsItemLinksItemBehavior];
+declare const GetTemplateAssets200GroupsItemLinksItemBehavior: {
+    readonly mirror_selection: "mirror_selection";
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+type GetTemplateAssets200GroupsItemLinksItem = {
+    /** @minLength 1 */
+    targetGroupId: string;
+    behavior: GetTemplateAssets200GroupsItemLinksItemBehavior;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200GroupsItemOffset = {
+    x: number;
+    y: number;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200GroupsItemPartsItem = {
+    /** @minLength 1 */
+    id: string;
+    label?: string;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type GetTemplateAssets200GroupsItemSize = {
+    /** @exclusiveMinimum 0 */
+    width: number;
+    /** @exclusiveMinimum 0 */
+    height: number;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+type GetTemplateAssets200GroupsItem = {
+    /** @minLength 1 */
+    id: string;
+    /** @minLength 1 */
+    label: string;
+    control?: GetTemplateAssets200GroupsItemControl;
+    hidden?: boolean;
+    /** @minLength 1 */
+    defaultPart: string;
+    /** @minLength 1 */
+    onPart?: string;
+    /** @minLength 1 */
+    offPart?: string;
+    /** @minItems 1 */
+    parts: GetTemplateAssets200GroupsItemPartsItem[];
+    layerOrder: number;
+    offset: GetTemplateAssets200GroupsItemOffset;
+    size: GetTemplateAssets200GroupsItemSize;
+    links?: GetTemplateAssets200GroupsItemLinksItem[];
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+type GetTemplateAssets200 = {
+    id: string;
+    name: string;
+    author: GetTemplateAssets200Author;
+    groups: GetTemplateAssets200GroupsItem[];
+    colorOptions: GetTemplateAssets200ColorOptionsItem[];
+    cropOptions: GetTemplateAssets200CropOptionsItem[];
+    defaultCrop: GetTemplateAssets200DefaultCrop;
+    renderSvgUrl: string;
+    assets: GetTemplateAssets200AssetsItem[];
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+type ListTemplates200TemplatesItemAuthor = {
+    name: string;
+    url?: string;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+type ListTemplates200TemplatesItem = {
+    id: string;
+    name: string;
+    author: ListTemplates200TemplatesItemAuthor;
+    templateUrl: string;
+    assetsUrl: string;
+    renderSvgUrl: string;
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+type ListTemplates200 = {
+    templates: ListTemplates200TemplatesItem[];
+};
+
+/**
+ * Generated by orval v8.13.0 🍺
+ * Do not edit manually.
+ * Humation Public API v1
+ * Public API for rendering Humation SVG assets.
+ * OpenAPI spec version: 0.1.0
+ */
+
+declare const getGetHealthUrl: () => string;
+/**
+ * @summary Check API availability
+ */
+declare const getHealth: (options?: RequestInit) => Promise<GetHealth200>;
+declare const getListTemplatesUrl: () => string;
+/**
+ * @summary List published templates
+ */
+declare const listTemplates: (options?: RequestInit) => Promise<ListTemplates200>;
+declare const getGetTemplateUrl: (templateId: string) => string;
+/**
+ * @summary Get a published template
+ */
+declare const getTemplate: (templateId: string, options?: RequestInit) => Promise<GetTemplate200>;
+declare const getGetTemplateAssetsUrl: (templateId: string) => string;
+/**
+ * @summary Get template assets
+ */
+declare const getTemplateAssets: (templateId: string, options?: RequestInit) => Promise<GetTemplateAssets200>;
+declare const getRenderTemplateSvgUrl: (templateId: string) => string;
+/**
+ * @summary Render a customized SVG avatar
+ */
+declare const renderTemplateSvg: (templateId: string, options?: RequestInit) => Promise<Blob>;
+
+declare const api_getGetHealthUrl: typeof getGetHealthUrl;
+declare const api_getGetTemplateAssetsUrl: typeof getGetTemplateAssetsUrl;
+declare const api_getGetTemplateUrl: typeof getGetTemplateUrl;
+declare const api_getHealth: typeof getHealth;
+declare const api_getListTemplatesUrl: typeof getListTemplatesUrl;
+declare const api_getRenderTemplateSvgUrl: typeof getRenderTemplateSvgUrl;
+declare const api_getTemplate: typeof getTemplate;
+declare const api_getTemplateAssets: typeof getTemplateAssets;
+declare const api_listTemplates: typeof listTemplates;
+declare const api_renderTemplateSvg: typeof renderTemplateSvg;
+declare namespace api {
+  export { api_getGetHealthUrl as getGetHealthUrl, api_getGetTemplateAssetsUrl as getGetTemplateAssetsUrl, api_getGetTemplateUrl as getGetTemplateUrl, api_getHealth as getHealth, api_getListTemplatesUrl as getListTemplatesUrl, api_getRenderTemplateSvgUrl as getRenderTemplateSvgUrl, api_getTemplate as getTemplate, api_getTemplateAssets as getTemplateAssets, api_listTemplates as listTemplates, api_renderTemplateSvg as renderTemplateSvg };
+}
+
+export { type AvatarAsset, type AvatarAssetsResponse, AvatarSession, type AvatarState, type AvatarTemplate, type Background, type CropId, type HexColor, HumationApiError, HumationClient, type HumationClientOptions, type LoadAvatarOptions, type TemplateColorOption, type TemplateCropOption, type TemplateGroup, type TemplatePart, type TemplateSummary, createHumationClient, api as raw };