yoto-nodejs-client 0.0.1 → 0.0.2

package/lib/api-endpoints/devices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"devices.d.ts","sourceRoot":"","sources":["devices.js"],"names":[],"mappings":"AA2CA,uEALG;IAAyB,WAAW,EAA3B,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,mBAAmB,CAAC,CAkBvC;AAkDD,sFANG;IAAyB,WAAW,EAA3B,MAAM;IACU,QAAQ,EAAxB,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,wBAAwB,CAAC,CAmB5C;AAkHD,sFANG;IAAyB,WAAW,EAA3B,MAAM;IACU,QAAQ,EAAxB,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,wBAAwB,CAAC,CAmB5C;AA0BD,uGAPG;IAAyB,WAAW,EAA3B,MAAM;IACU,QAAQ,EAAxB,MAAM;IACiC,YAAY,EAAnD,6BAA6B;IACZ,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,8BAA8B,CAAC,CAwBlD;AAyBD,6GAPG;IAAyB,WAAW,EAA3B,MAAM;IACU,QAAQ,EAAxB,MAAM;IAC8B,eAAe,EAAnD,0BAA0B;IACT,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,2BAA2B,CAAC,CAwB/C;AA6BD,iGAPG;IAAyB,WAAW,EAA3B,MAAM;IACU,QAAQ,EAAxB,MAAM;IACqB,OAAO,EAAlC,iBAAiB;IACA,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,yBAAyB,CAAC,CAwB7C;;aAnYa,UAAU,EAAE;;;cAMZ,MAAM;UACN,MAAM;iBACN,MAAM;YACN,OAAO;oBACP,MAAM;gBACN,MAAM;kBACN,MAAM;iBACN,MAAM;iBACN,MAAM;iBACN,MAAM;;;cAiCN,MAAM;iBACN,MAAM;gCACN,MAAM;sCACN,MAAM;6BACN,MAAM;gCACN,MAAM;iBACN,MAAM;yBACN,CAAC,GAAG,CAAC,GAAG,CAAC;cACT,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;mBACV,MAAM;sBACN,MAAM;yBACN,MAAM;6BACN,OAAO;iCACP,OAAO;gCACP,OAAO;iBACP,OAAO;kBACP,MAAM;eACN,OAAO;kBACP,MAAM;qBACN,MAAM;oBACN,MAAM;wBACN,MAAM,GAAG,IAAI;kBACb,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;6BACb,MAAM;+BACN,MAAM;yBACN,MAAM,GAAG,MAAM;0BACf,MAAM;gBACN,MAAM;aACN,MAAM;2BACN,MAAM;uBACN,MAAM;cACN,MAAM;mBACN,MAAM;;;YAmCN,sBAAsB;;;YAMtB,gBAAgB;kBAChB,MAAM;iBACN,MAAM;cACN,MAAM;gBACN,MAAM;eACN,GAAG;iBACH,MAAM;cACN,MAAM;SACN,MAAM;UACN,MAAM;YACN,OAAO;sBACP,MAAM;uBACN,MAAM;aACN,MAAM;sBACN,MAAM;2BACN,MAAM;eACN,MAAM;aACN,GAAG;gBACH,mBAAmB;;;aAMnB,MAAM,EAAE;mBACR,MAAM;sBACN,MAAM;yBACN,OAAO;gBACP,MAAM;0BACN,MAAM;aACN,MAAM;kBACN,MAAM;kBACN,MAAM;mBACN,MAAM;2BACN,MAAM;uBACN,MAAM;6BACN,OAAO;iBACP,MAAM;eACN,MAAM;aACN,MAAM;oBACN,MAAM;wBACN,MAAM;4BACN,MAAM;yBACN,MAAM;eACN,MAAM;oBACN,MAAM;oBACN,MAAM;qBACN,MAAM;uBACN,OAAO;sBACP,OAAO;eACP,OAAO;sBACP,OAAO;qBACP,MAAM;mBACN,MAAM;eACN,MAAM;kBACN,MAAM;;;WAMN,iBAAiB;eACjB,MAAM;;;SAMN,gBAAgB;WAChB,gBAAgB;;;aAMhB,mBAAmB,EAAE;;;SAMrB,MAAM;YACN,kBAAkB;;;UAMlB,MAAM;aACN,MAAM;WACN,MAAM;;;WAmCN,MAAM;YACN,OAAO,CAAC,gBAAgB,CAAC;;;YAMzB,MAAM;;;eAyCN,mBAAmB;;;YAMnB,MAAM;;;YA0CN,MAAM;;gCAOP,iBAAiB,GAAG,kBAAkB,GAAG,qBAAqB,GAAG,oBAAoB,GAAG,oBAAoB,GAAG,yBAAyB,GAAG,EAAE;uCA5WF,qBAAqB;wCAArB,qBAAqB;2CAArB,qBAAqB;0CAArB,qBAAqB;0CAArB,qBAAqB;+CAArB,qBAAqB"}
+{"version":3,"file":"devices.d.ts","sourceRoot":"","sources":["devices.js"],"names":[],"mappings":"AAaA;;;;GAIG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;GAQG;AACH,uEALG;IAAyB,WAAW,EAA3B,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,mBAAmB,CAAC,CAkBvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH;;;;;;;;;GASG;AACH,sFANG;IAAyB,WAAW,EAA3B,MAAM;IACU,QAAQ,EAAxB,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,wBAAwB,CAAC,CAmB5C;AAED;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;GASG;AACH,sFANG;IAAyB,WAAW,EAA3B,MAAM;IACU,QAAQ,EAAxB,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,wBAAwB,CAAC,CAmB5C;AAED;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;;;;;;;;GAUG;AACH,uGAPG;IAAyB,WAAW,EAA3B,MAAM;IACU,QAAQ,EAAxB,MAAM;IACiC,YAAY,EAAnD,6BAA6B;IACZ,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,8BAA8B,CAAC,CAwBlD;AAED;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;;;GAUG;AACH,6GAPG;IAAyB,WAAW,EAA3B,MAAM;IACU,QAAQ,EAAxB,MAAM;IAC8B,eAAe,EAAnD,0BAA0B;IACT,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,2BAA2B,CAAC,CAwB/C;AAED;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;;GAYG;AACH,iGAPG;IAAyB,WAAW,EAA3B,MAAM;IACU,QAAQ,EAAxB,MAAM;IACqB,OAAO,EAAlC,iBAAiB;IACA,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,yBAAyB,CAAC,CAwB7C;;aAnYa,UAAU,EAAE;;;;;;cAMZ,MAAM;;;;UACN,MAAM;;;;iBACN,MAAM;;;;YACN,OAAO;;;;oBACP,MAAM;;;;gBACN,MAAM;;;;kBACN,MAAM;;;;iBACN,MAAM;;;;iBACN,MAAM;;;;iBACN,MAAM;;;;;;cAiCN,MAAM;;;;iBACN,MAAM;;;;gCACN,MAAM;;;;sCACN,MAAM;;;;6BACN,MAAM;;;;gCACN,MAAM;;;;iBACN,MAAM;;;;yBACN,CAAC,GAAG,CAAC,GAAG,CAAC;;;;cACT,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;;;;mBACV,MAAM;;;;sBACN,MAAM;;;;yBACN,MAAM;;;;6BACN,OAAO;;;;iCACP,OAAO;;;;gCACP,OAAO;;;;iBACP,OAAO;;;;kBACP,MAAM;;;;eACN,OAAO;;;;kBACP,MAAM;;;;qBACN,MAAM;;;;oBACN,MAAM;;;;wBACN,MAAM,GAAG,IAAI;;;;kBACb,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;;;;6BACb,MAAM;;;;+BACN,MAAM;;;;yBACN,MAAM,GAAG,MAAM;;;;0BACf,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;;;2BACN,MAAM;;;;uBACN,MAAM;;;;cACN,MAAM;;;;mBACN,MAAM;;;YAmCN,sBAAsB;;;;;;YAMtB,gBAAgB;;;;kBAChB,MAAM;;;;iBACN,MAAM;;;;cACN,MAAM;;;;gBACN,MAAM;;;;eACN,GAAG;;;;iBACH,MAAM;;;;cACN,MAAM;;;;SACN,MAAM;;;;UACN,MAAM;;;;YACN,OAAO;;;;sBACP,MAAM;;;;uBACN,MAAM;;;;aACN,MAAM;;;;sBACN,MAAM;;;;2BACN,MAAM;;;;eACN,MAAM;;;;aACN,GAAG;;;;gBACH,mBAAmB;;;;;;aAMnB,MAAM,EAAE;;;;mBACR,MAAM;;;;sBACN,MAAM;;;;yBACN,OAAO;;;;gBACP,MAAM;;;;0BACN,MAAM;;;;aACN,MAAM;;;;kBACN,MAAM;;;;kBACN,MAAM;;;;mBACN,MAAM;;;;2BACN,MAAM;;;;uBACN,MAAM;;;;6BACN,OAAO;;;;iBACP,MAAM;;;;eACN,MAAM;;;;aACN,MAAM;;;;oBACN,MAAM;;;;wBACN,MAAM;;;;4BACN,MAAM;;;;yBACN,MAAM;;;;eACN,MAAM;;;;oBACN,MAAM;;;;oBACN,MAAM;;;;qBACN,MAAM;;;;uBACN,OAAO;;;;sBACP,OAAO;;;;eACP,OAAO;;;;sBACP,OAAO;;;;qBACP,MAAM;;;;mBACN,MAAM;;;;eACN,MAAM;;;;kBACN,MAAM;;;;;;WAMN,iBAAiB;;;;eACjB,MAAM;;;;;;SAMN,gBAAgB;;;;WAChB,gBAAgB;;;;;;aAMhB,mBAAmB,EAAE;;;;;;SAMrB,MAAM;;;;YACN,kBAAkB;;;;;;UAMlB,MAAM;;;;aACN,MAAM;;;;WACN,MAAM;;;;;;WAmCN,MAAM;;;;YACN,OAAO,CAAC,gBAAgB,CAAC;;;;;;YAMzB,MAAM;;;;;;eAyCN,mBAAmB;;;;;;YAMnB,MAAM;;;;;;YA0CN,MAAM;;;;;;gCAOP,iBAAiB,GAAG,kBAAkB,GAAG,qBAAqB,GAAG,oBAAoB,GAAG,oBAAoB,GAAG,yBAAyB,GAAG,EAAE;uCA5WF,qBAAqB;wCAArB,qBAAqB;2CAArB,qBAAqB;0CAArB,qBAAqB;0CAArB,qBAAqB;+CAArB,qBAAqB"}

package/lib/api-endpoints/family-library-groups.d.ts

@@ -1,3 +1,48 @@
+/**
+ * @see https://yoto.dev/api/getgroups/
+ * @typedef {Object} YotoGroupsResponse
+ * @property {YotoGroup[]} groups - Array of family library groups
+ */
+/**
+ * @see https://yoto.dev/api/getgroups/
+ * @typedef {Object} YotoGroup
+ * @property {string} id - Group identifier
+ * @property {string} name - Group name (e.g., "My Favourites")
+ * @property {string} familyId - Associated family ID
+ * @property {string} imageId - ID for the group image (can be uploaded family image hash or preset like "fp-cards")
+ * @property {string} imageUrl - CDN URL to the group image
+ * @property {YotoGroupItem[]} items - Array of content items in the group
+ * @property {any[]} cards - Array of card objects
+ * @property {string} createdAt - ISO 8601 timestamp when group was created
+ * @property {string} lastModifiedAt - ISO 8601 timestamp when group was last updated
+ */
+/**
+ * @see https://yoto.dev/api/getgroups/
+ * @typedef {Object} YotoGroupItem
+ * @property {string} contentId - ID of the card content
+ * @property {string} addedAt - ISO 8601 timestamp when item was added to group
+ */
+/**
+ * Retrieves all family library groups for the authenticated user's family.
+ * Returns an empty array if no groups exist.
+ * @see https://yoto.dev/api/getgroups/
+ * @param  {object} options
+ * @param  {string} options.accessToken    The API token to request with
+ * @param  {string} [options.userAgent]  Optional user agent string
+ * @param  {RequestOptions} [options.requestOptions]  Additional undici request options
+ * @return {Promise<YotoGroup[]>} Array of family library groups
+ * @example
+ * import { getGroups } from 'yoto-nodejs-client'
+ *
+ * const groups = await getGroups({
+ *   accessToken
+ * })
+ *
+ * console.log('Groups:', groups.length)
+ * groups.forEach(group => {
+ *   console.log(`${group.name}: ${group.items.length} items`)
+ * })
+ */
 export function getGroups({ accessToken, userAgent, requestOptions }: {
     accessToken: string;
     userAgent?: string | undefined;
@@ -5,6 +50,42 @@ export function getGroups({ accessToken, userAgent, requestOptions }: {
         dispatcher?: import("undici").Dispatcher;
     } & Omit<import("undici").Dispatcher.RequestOptions<unknown>, "origin" | "path" | "method"> & Partial<Pick<import("undici").Dispatcher.RequestOptions<null>, "method">>) | undefined;
 }): Promise<YotoGroup[]>;
+/**
+ * @see https://yoto.dev/api/createagroup/
+ * @typedef {Object} YotoCreateGroupRequest
+ * @property {string} name - Group name (max 100 characters, UTF-8 supported)
+ * @property {string} imageId - Image ID (preset like "fp-cards" or uploaded image hash)
+ * @property {YotoGroupItemInput[]} items - Array of content items (can be empty, order preserved)
+ */
+/**
+ * @see https://yoto.dev/api/createagroup/
+ * @typedef {Object} YotoGroupItemInput
+ * @property {string} contentId - ID of the card content to add to group
+ */
+/**
+ * Creates a new group in the family library.
+ * Max 20 groups per family. ContentIds must be in family's library (invalid ones filtered out).
+ * @see https://yoto.dev/api/createagroup/
+ * @param  {object} options
+ * @param  {string} options.token    The API token to request with
+ * @param  {YotoCreateGroupRequest} options.group The group data to create
+ * @param  {string} [options.userAgent]  Optional user agent string
+ * @param  {RequestOptions} [options.requestOptions]  Additional undici request options
+ * @return {Promise<YotoGroup>} The created group with populated cards array
+ * @example
+ * import { createGroup } from 'yoto-nodejs-client'
+ *
+ * const group = await createGroup({
+ *   token: accessToken,
+ *   group: {
+ *     name: 'My Favourites',
+ *     imageId: 'fp-cards',
+ *     items: [
+ *       { contentId: '37KwQ' }
+ *     ]
+ *   }
+ * })
+ */
 export function createGroup({ token, userAgent, group, requestOptions }: {
     token: string;
     group: YotoCreateGroupRequest;
@@ -13,6 +94,17 @@ export function createGroup({ token, userAgent, group, requestOptions }: {
         dispatcher?: import("undici").Dispatcher;
     } & Omit<import("undici").Dispatcher.RequestOptions<unknown>, "origin" | "path" | "method"> & Partial<Pick<import("undici").Dispatcher.RequestOptions<null>, "method">>) | undefined;
 }): Promise<YotoGroup>;
+/**
+ * Retrieves a specific group by ID.
+ * Returns 404 if group doesn't exist or belongs to another family.
+ * @see https://yoto.dev/api/getagroup/
+ * @param  {object} options
+ * @param  {string} options.accessToken    The API token to request with
+ * @param  {string} options.groupId  The group ID to retrieve
+ * @param  {string} [options.userAgent]  Optional user agent string
+ * @param  {RequestOptions} [options.requestOptions]  Additional undici request options
+ * @return {Promise<YotoGroup>} The requested group with populated cards array
+ */
 export function getGroup({ accessToken, userAgent, groupId, requestOptions }: {
     accessToken: string;
     groupId: string;
@@ -21,6 +113,25 @@ export function getGroup({ accessToken, userAgent, groupId, requestOptions }: {
         dispatcher?: import("undici").Dispatcher;
     } & Omit<import("undici").Dispatcher.RequestOptions<unknown>, "origin" | "path" | "method"> & Partial<Pick<import("undici").Dispatcher.RequestOptions<null>, "method">>) | undefined;
 }): Promise<YotoGroup>;
+/**
+ * @see https://yoto.dev/api/updateagroup/
+ * @typedef {Object} YotoUpdateGroupRequest
+ * @property {string} name - Group name (max 100 characters, UTF-8 supported)
+ * @property {string} imageId - Image ID (preset like "fp-cards" or uploaded image hash)
+ * @property {YotoGroupItemInput[]} items - Array of content items (replaces entire array)
+ */
+/**
+ * Updates an existing group.
+ * Can only update groups owned by family. Returns 404 if doesn't exist or owned by another family.
+ * @see https://yoto.dev/api/updateagroup/
+ * @param  {object} options
+ * @param  {string} options.accessToken    The API token to request with
+ * @param  {string} options.groupId  The group ID to update
+ * @param  {YotoUpdateGroupRequest} options.group The updated group data
+ * @param  {string} [options.userAgent]  Optional user agent string
+ * @param  {RequestOptions} [options.requestOptions]  Additional undici request options
+ * @return {Promise<YotoGroup>} The updated group with populated cards array
+ */
 export function updateGroup({ accessToken, userAgent, groupId, group, requestOptions }: {
     accessToken: string;
     groupId: string;
@@ -30,6 +141,22 @@ export function updateGroup({ accessToken, userAgent, groupId, group, requestOpt
         dispatcher?: import("undici").Dispatcher;
     } & Omit<import("undici").Dispatcher.RequestOptions<unknown>, "origin" | "path" | "method"> & Partial<Pick<import("undici").Dispatcher.RequestOptions<null>, "method">>) | undefined;
 }): Promise<YotoGroup>;
+/**
+ * @see https://yoto.dev/api/deleteagroup/
+ * @typedef {Object} YotoDeleteGroupResponse
+ * @property {string} id - The ID of the deleted group
+ */
+/**
+ * Deletes a group permanently (hard delete, cannot be recovered).
+ * Content remains in family library. Returns 404 if doesn't exist or owned by another family.
+ * @see https://yoto.dev/api/deleteagroup/
+ * @param  {object} options
+ * @param  {string} options.accessToken    The API token to request with
+ * @param  {string} options.groupId  The group ID to delete
+ * @param  {string} [options.userAgent]  Optional user agent string
+ * @param  {RequestOptions} [options.requestOptions]  Additional undici request options
+ * @return {Promise<YotoDeleteGroupResponse>} Confirmation with deleted group ID
+ */
 export function deleteGroup({ accessToken, userAgent, groupId, requestOptions }: {
     accessToken: string;
     groupId: string;
@@ -39,37 +166,97 @@ export function deleteGroup({ accessToken, userAgent, groupId, requestOptions }:
     } & Omit<import("undici").Dispatcher.RequestOptions<unknown>, "origin" | "path" | "method"> & Partial<Pick<import("undici").Dispatcher.RequestOptions<null>, "method">>) | undefined;
 }): Promise<YotoDeleteGroupResponse>;
 export type YotoGroupsResponse = {
+    /**
+     * - Array of family library groups
+     */
     groups: YotoGroup[];
 };
 export type YotoGroup = {
+    /**
+     * - Group identifier
+     */
     id: string;
+    /**
+     * - Group name (e.g., "My Favourites")
+     */
     name: string;
+    /**
+     * - Associated family ID
+     */
     familyId: string;
+    /**
+     * - ID for the group image (can be uploaded family image hash or preset like "fp-cards")
+     */
     imageId: string;
+    /**
+     * - CDN URL to the group image
+     */
     imageUrl: string;
+    /**
+     * - Array of content items in the group
+     */
     items: YotoGroupItem[];
+    /**
+     * - Array of card objects
+     */
     cards: any[];
+    /**
+     * - ISO 8601 timestamp when group was created
+     */
     createdAt: string;
+    /**
+     * - ISO 8601 timestamp when group was last updated
+     */
     lastModifiedAt: string;
 };
 export type YotoGroupItem = {
+    /**
+     * - ID of the card content
+     */
     contentId: string;
+    /**
+     * - ISO 8601 timestamp when item was added to group
+     */
     addedAt: string;
 };
 export type YotoCreateGroupRequest = {
+    /**
+     * - Group name (max 100 characters, UTF-8 supported)
+     */
     name: string;
+    /**
+     * - Image ID (preset like "fp-cards" or uploaded image hash)
+     */
     imageId: string;
+    /**
+     * - Array of content items (can be empty, order preserved)
+     */
     items: YotoGroupItemInput[];
 };
 export type YotoGroupItemInput = {
+    /**
+     * - ID of the card content to add to group
+     */
     contentId: string;
 };
 export type YotoUpdateGroupRequest = {
+    /**
+     * - Group name (max 100 characters, UTF-8 supported)
+     */
     name: string;
+    /**
+     * - Image ID (preset like "fp-cards" or uploaded image hash)
+     */
     imageId: string;
+    /**
+     * - Array of content items (replaces entire array)
+     */
     items: YotoGroupItemInput[];
 };
 export type YotoDeleteGroupResponse = {
+    /**
+     * - The ID of the deleted group
+     */
     id: string;
 };
 //# sourceMappingURL=family-library-groups.d.ts.map

package/lib/api-endpoints/family-library-groups.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"family-library-groups.d.ts","sourceRoot":"","sources":["family-library-groups.js"],"names":[],"mappings":"AA2DA,sEAhBG;IAAyB,WAAW,EAA3B,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,SAAS,EAAE,CAAC,CA6B/B;AAwCD,yEAnBG;IAAyB,KAAK,EAArB,MAAM;IAC0B,KAAK,EAArC,sBAAsB;IACL,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,SAAS,CAAC,CAoC7B;AAaD,8EANG;IAAyB,WAAW,EAA3B,MAAM;IACU,OAAO,EAAvB,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,SAAS,CAAC,CAmB7B;AAsBD,wFAPG;IAAyB,WAAW,EAA3B,MAAM;IACU,OAAO,EAAvB,MAAM;IAC0B,KAAK,EAArC,sBAAsB;IACL,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,SAAS,CAAC,CAwB7B;AAmBD,iFANG;IAAyB,WAAW,EAA3B,MAAM;IACU,OAAO,EAAvB,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,uBAAuB,CAAC,CAmB3C;;YAxOa,SAAS,EAAE;;;QAMX,MAAM;UACN,MAAM;cACN,MAAM;aACN,MAAM;cACN,MAAM;WACN,aAAa,EAAE;WACf,GAAG,EAAE;eACL,MAAM;oBACN,MAAM;;;eAMN,MAAM;aACN,MAAM;;;UA6CN,MAAM;aACN,MAAM;WACN,kBAAkB,EAAE;;;eAMpB,MAAM;;;UAmFN,MAAM;aACN,MAAM;WACN,kBAAkB,EAAE;;;QA0CpB,MAAM"}
+{"version":3,"file":"family-library-groups.d.ts","sourceRoot":"","sources":["family-library-groups.js"],"names":[],"mappings":"AAWA;;;;GAIG;AAEH;;;;;;;;;;;;GAYG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,sEAhBG;IAAyB,WAAW,EAA3B,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,SAAS,EAAE,CAAC,CA6B/B;AAED;;;;;;GAMG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,yEAnBG;IAAyB,KAAK,EAArB,MAAM;IAC0B,KAAK,EAArC,sBAAsB;IACL,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,SAAS,CAAC,CAoC7B;AAED;;;;;;;;;;GAUG;AACH,8EANG;IAAyB,WAAW,EAA3B,MAAM;IACU,OAAO,EAAvB,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,SAAS,CAAC,CAmB7B;AAED;;;;;;GAMG;AAEH;;;;;;;;;;;GAWG;AACH,wFAPG;IAAyB,WAAW,EAA3B,MAAM;IACU,OAAO,EAAvB,MAAM;IAC0B,KAAK,EAArC,sBAAsB;IACL,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,SAAS,CAAC,CAwB7B;AAED;;;;GAIG;AAEH;;;;;;;;;;GAUG;AACH,iFANG;IAAyB,WAAW,EAA3B,MAAM;IACU,OAAO,EAAvB,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,uBAAuB,CAAC,CAmB3C;;;;;YAxOa,SAAS,EAAE;;;;;;QAMX,MAAM;;;;UACN,MAAM;;;;cACN,MAAM;;;;aACN,MAAM;;;;cACN,MAAM;;;;WACN,aAAa,EAAE;;;;WACf,GAAG,EAAE;;;;eACL,MAAM;;;;oBACN,MAAM;;;;;;eAMN,MAAM;;;;aACN,MAAM;;;;;;UA6CN,MAAM;;;;aACN,MAAM;;;;WACN,kBAAkB,EAAE;;;;;;eAMpB,MAAM;;;;;;UAmFN,MAAM;;;;aACN,MAAM;;;;WACN,kBAAkB,EAAE;;;;;;QA0CpB,MAAM"}

package/lib/api-endpoints/family.d.ts

@@ -1,3 +1,23 @@
+/**
+ * @see https://yoto.dev/api/getfamilyimages/
+ * @typedef {Object} YotoFamilyImagesResponse
+ * @property {YotoFamilyImage[]} images
+ */
+/**
+ * @see https://yoto.dev/api/getfamilyimages/
+ * @typedef {Object} YotoFamilyImage
+ * @property {string} imageId - The unique identifier for the family image (hash)
+ * @property {string} [name] - Optional name of the family image
+ */
+/**
+ * Retrieves the list of families associated with the authenticated user.
+ * @see https://yoto.dev/api/getfamilyimages/
+ * @param  {object} options
+ * @param  {string} options.accessToken    The API token to request with
+ * @param  {string} [options.userAgent]  Optional user agent string
+ * @param  {RequestOptions} [options.requestOptions]  Additional undici request options
+ * @return {Promise<YotoFamilyImagesResponse>} The user's families
+ */
 export function getFamilyImages({ accessToken, userAgent, requestOptions }: {
     accessToken: string;
     userAgent?: string | undefined;
@@ -5,6 +25,23 @@ export function getFamilyImages({ accessToken, userAgent, requestOptions }: {
         dispatcher?: import("undici").Dispatcher;
     } & Omit<import("undici").Dispatcher.RequestOptions<unknown>, "origin" | "path" | "method"> & Partial<Pick<import("undici").Dispatcher.RequestOptions<null>, "method">>) | undefined;
 }): Promise<YotoFamilyImagesResponse>;
+/**
+ * @see https://yoto.dev/api/getafamilyimage/
+ * @typedef {Object} YotoFamilyImageResponse
+ * @property {string} imageUrl - The signed URL to the family image (expires after 7 days)
+ */
+/**
+ * Retrieves a signed URL for a specific family image. Returns a 302 redirect with the image URL in the Location header.
+ * The signed URL expires after 7 days.
+ * @see https://yoto.dev/api/getafamilyimage/
+ * @param  {object} options
+ * @param  {string} options.accessToken    The API token to request with
+ * @param  {string} options.imageId The family image ID (hash) to get the image for
+ * @param  {'640x480' | '320x320'} options.size Image dimensions (supported: '640x480' or '320x320')
+ * @param  {string} [options.userAgent]  Optional user agent string
+ * @param  {RequestOptions} [options.requestOptions]  Additional undici request options
+ * @return {Promise<YotoFamilyImageResponse>} The signed image URL
+ */
 export function getAFamilyImage({ accessToken, userAgent, imageId, size, requestOptions }: {
     accessToken: string;
     imageId: string;
@@ -14,6 +51,42 @@ export function getAFamilyImage({ accessToken, userAgent, imageId, size, request
         dispatcher?: import("undici").Dispatcher;
     } & Omit<import("undici").Dispatcher.RequestOptions<unknown>, "origin" | "path" | "method"> & Partial<Pick<import("undici").Dispatcher.RequestOptions<null>, "method">>) | undefined;
 }): Promise<YotoFamilyImageResponse>;
+/**
+ * @see https://yoto.dev/api/uploadafamilyimage/
+ * @typedef {Object} YotoUploadFamilyImageResponse
+ * @property {string} imageId - The SHA256 checksum of the uploaded image
+ * @property {string} url - URL to the 'get a family image' endpoint (requires width/height params)
+ */
+/**
+ * Uploads a family image for use across various features in Yoto.
+ * Images are deduplicated using SHA256 checksums.
+ *
+ * Constraints:
+ * - Max size: 8mb
+ * - Supported formats: JPEG, GIF, PNG
+ * - Limit: 500 images per family
+ * - No restrictions on resolution or aspect ratio
+ *
+ * @see https://yoto.dev/api/uploadafamilyimage/
+ * @param  {object} options
+ * @param  {string} options.accessToken    The API token to request with
+ * @param  {Buffer} options.imageData The binary image data (JPEG, GIF, or PNG)
+ * @param  {string} [options.userAgent]  Optional user agent string
+ * @param  {RequestOptions} [options.requestOptions]  Additional undici request options
+ * @return {Promise<YotoUploadFamilyImageResponse>} The uploaded image details
+ * @example
+ * import { readFile } from 'fs/promises'
+ * import { uploadAFamilyImage } from 'yoto-nodejs-client'
+ *
+ * const imageData = await readFile('./family-photo.jpg')
+ * const result = await uploadAFamilyImage({
+ *   accessToken,
+ *   imageData
+ * })
+ *
+ * console.log('Image ID:', result.imageId)
+ * console.log('Image URL:', result.url)
+ */
 export function uploadAFamilyImage({ accessToken, userAgent, imageData, requestOptions }: {
     accessToken: string;
     imageData: Buffer;
@@ -26,14 +99,29 @@ export type YotoFamilyImagesResponse = {
     images: YotoFamilyImage[];
 };
 export type YotoFamilyImage = {
+    /**
+     * - The unique identifier for the family image (hash)
+     */
     imageId: string;
+    /**
+     * - Optional name of the family image
+     */
     name?: string;
 };
 export type YotoFamilyImageResponse = {
+    /**
+     * - The signed URL to the family image (expires after 7 days)
+     */
     imageUrl: string;
 };
 export type YotoUploadFamilyImageResponse = {
+    /**
+     * - The SHA256 checksum of the uploaded image
+     */
     imageId: string;
+    /**
+     * - URL to the 'get a family image' endpoint (requires width/height params)
+     */
     url: string;
 };
 //# sourceMappingURL=family.d.ts.map

package/lib/api-endpoints/family.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"family.d.ts","sourceRoot":"","sources":["family.js"],"names":[],"mappings":"AAiCA,4EALG;IAAyB,WAAW,EAA3B,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,wBAAwB,CAAC,CAkB5C;AAoBD,2FAPG;IAAyB,WAAW,EAA3B,MAAM;IACU,OAAO,EAAvB,MAAM;IACyB,IAAI,EAAnC,SAAS,GAAG,SAAS;IACJ,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,uBAAuB,CAAC,CAsC3C;AAuCD,0FAlBG;IAAyB,WAAW,EAA3B,MAAM;IACU,SAAS,EAAzB,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,6BAA6B,CAAC,CAmCjD;;YAvJa,eAAe,EAAE;;;aAMjB,MAAM;WACN,MAAM;;;cAiCN,MAAM;;;aAwDN,MAAM;SACN,MAAM"}
+{"version":3,"file":"family.d.ts","sourceRoot":"","sources":["family.js"],"names":[],"mappings":"AAWA;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;;;GAQG;AACH,4EALG;IAAyB,WAAW,EAA3B,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,wBAAwB,CAAC,CAkB5C;AAED;;;;GAIG;AAEH;;;;;;;;;;;GAWG;AACH,2FAPG;IAAyB,WAAW,EAA3B,MAAM;IACU,OAAO,EAAvB,MAAM;IACyB,IAAI,EAAnC,SAAS,GAAG,SAAS;IACJ,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,uBAAuB,CAAC,CAsC3C;AAED;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,0FAlBG;IAAyB,WAAW,EAA3B,MAAM;IACU,SAAS,EAAzB,MAAM;IACW,SAAS;IACD,cAAc;;;CAChD,GAAS,OAAO,CAAC,6BAA6B,CAAC,CAmCjD;;YAvJa,eAAe,EAAE;;;;;;aAMjB,MAAM;;;;WACN,MAAM;;;;;;cAiCN,MAAM;;;;;;aAwDN,MAAM;;;;SACN,MAAM"}

package/lib/api-endpoints/helpers.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Request options derived from undici.request
+ * @typedef {NonNullable<Parameters<typeof request>[1]>} RequestOptions
+ */
+/**
+ * @param {object} [options]
+ * @param {string} [options.userAgent] - Optional user agent string to prepend to library user agent
+ * @param {RequestOptions} [options.requestOptions] - Additional undici request options
+ */
 export function defaultHeaders(options?: {
     userAgent?: string | undefined;
     requestOptions?: ({
@@ -7,6 +16,11 @@ export function defaultHeaders(options?: {
     Accept: string;
     'User-Agent': string;
 };
+/**
+ * @param  {object} params
+ * @param  {string} params.accessToken
+ * @param {string} [params.userAgent] - Optional user agent string to prepend to library user agent
+ */
 export function defaultAuthHeaders({ accessToken: token, userAgent }: {
     accessToken: string;
     userAgent?: string | undefined;
@@ -15,14 +29,34 @@ export function defaultAuthHeaders({ accessToken: token, userAgent }: {
     Accept: string;
     'User-Agent': string;
 };
+/**
+ * Merge undici request options with defaults
+ * Properly merges headers by supplementing rather than overriding
+ * Only supports object headers (not arrays)
+ * @param {RequestOptions} baseOptions - Base request options with headers
+ * @param {RequestOptions} [requestOptions] - Additional request options to merge
+ * @returns {object} Merged options
+ */
 export function mergeRequestOptions(baseOptions: RequestOptions, requestOptions?: RequestOptions): object;
+/**
+ * @param  {Dispatcher.ResponseData} response
+ * @param  {any} [extra]
+ */
 export function handleBadResponse(response: Dispatcher.ResponseData, extra?: any): Promise<void>;
 export class YotoAPIError extends Error {
+    /**
+     * @param  {Dispatcher.ResponseData} response A undici Response
+     * @param  {string | object} body response body
+     * @param  {any} [extra] any extra info to attach to the error
+     */
     constructor(response: Dispatcher.ResponseData, body: string | object, extra?: any);
-    statusCode: number;
-    body: string | object;
-    extra: any;
+    /** @type { number } */ statusCode: number;
+    /** @type {string | object } */ body: string | object;
+    /** @type {any} */ extra: any;
 }
+/**
+ * Request options derived from undici.request
+ */
 export type RequestOptions = NonNullable<Parameters<typeof request>[1]>;
 import type { Dispatcher } from 'undici';
 import type { request } from 'undici';

package/lib/api-endpoints/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["helpers.js"],"names":[],"mappings":"AAiBA,yCAHG;IAAyB,SAAS;IACD,cAAc;;;CACjD;;;EAWA;AAOD,sEAHG;IAAwB,WAAW,EAA1B,MAAM;IACS,SAAS;CACnC;;;;EAMA;AAUD,iDAJW,cAAc,mBACd,cAAc,GACZ,MAAM,CAoBlB;AAMD,4CAHY,uBAAuB,UACvB,GAAG,iBAWd;AAED;IAUE,sBAJY,uBAAuB,QACvB,MAAM,GAAG,MAAM,UACf,GAAG,EAUd;IAjBuB,YAAZ,MAAM,CAAgB;IACF,MAArB,MAAM,GAAG,MAAM,CAAU;IACjB,OAAR,GAAG,CAAU;CAgBzB;6BA9FY,WAAW,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;gCARxB,QAAQ;6BACX,QAAQ"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["helpers.js"],"names":[],"mappings":"AAOA;;;GAGG;AAEH;;;;GAIG;AACH,yCAHG;IAAyB,SAAS;IACD,cAAc;;;CACjD;;;EAWA;AAED;;;;GAIG;AACH,sEAHG;IAAwB,WAAW,EAA1B,MAAM;IACS,SAAS;CACnC;;;;EAMA;AAED;;;;;;;GAOG;AACH,iDAJW,cAAc,mBACd,cAAc,GACZ,MAAM,CAoBlB;AAED;;;GAGG;AACH,4CAHY,uBAAuB,UACvB,GAAG,iBAWd;AAED;IAKE;;;;OAIG;IACH,sBAJY,uBAAuB,QACvB,MAAM,GAAG,MAAM,UACf,GAAG,EAUd;IAjBD,uBAAuB,CAAC,YAAZ,MAAM,CAAgB;IAClC,+BAA+B,CAAC,MAArB,MAAM,GAAG,MAAM,CAAU;IACpC,kBAAkB,CAAC,OAAR,GAAG,CAAU;CAgBzB;;;;6BA9FY,WAAW,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;gCARxB,QAAQ;6BACX,QAAQ"}