@snagsolutions/sdk 0.1.0-alpha.11 → 0.1.0-alpha.111

package/resources.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resources/index.js"), exports);
+//# sourceMappingURL=resources.js.map

package/resources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAkC"}

package/resources.mjs

@@ -0,0 +1,2 @@
+export * from "./resources/index.mjs";
+//# sourceMappingURL=resources.mjs.map

package/resources.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}

package/src/_shims/index.d.ts

@@ -79,3 +79,5 @@ export function fileFromPath(path: string, options?: FileFromPathOptions): Promi
 export function fileFromPath(path: string, filename?: string, options?: FileFromPathOptions): Promise<File>;
 
 export function isFsReadStream(value: any): value is FsReadStream;
+
+export const init: () => void;

package/src/_shims/index.js

@@ -3,7 +3,9 @@
  */
 const shims = require('./registry');
 const auto = require('@snagsolutions/sdk/_shims/auto/runtime');
-if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+exports.init = () => {
+  if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+};
 for (const property of Object.keys(shims)) {
   Object.defineProperty(exports, property, {
     get() {
@@ -11,3 +13,5 @@ for (const property of Object.keys(shims)) {
     },
   });
 }
+
+exports.init();

package/src/_shims/index.mjs

@@ -3,5 +3,9 @@
  */
 import * as shims from './registry.mjs';
 import * as auto from "./auto/runtime";
-if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+export const init = () => {
+  if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+};
 export * from './registry.mjs';
+
+init();

package/src/core.ts

@@ -16,7 +16,12 @@ import {
   type RequestInit,
   type Response,
   type HeadersInit,
+  init,
 } from './_shims/index';
+
+// try running side effects outside of _shims/index to workaround https://github.com/vercel/next.js/issues/76881
+init();
+
 export { type Response };
 import { BlobLike, isBlobLike, isMultipartBody } from './uploads';
 export {
@@ -28,6 +33,20 @@ export {
 
 export type Fetch = (url: RequestInfo, init?: RequestInit) => Promise<Response>;
 
+/**
+ * An alias to the builtin `Array` type so we can
+ * easily alias it in import statements if there are name clashes.
+ */
+type _Array<T> = Array<T>;
+
+/**
+ * An alias to the builtin `Record` type so we can
+ * easily alias it in import statements if there are name clashes.
+ */
+type _Record<K extends keyof any, T> = Record<K, T>;
+
+export type { _Array as Array, _Record as Record };
+
 type PromiseOrValue<T> = T | Promise<T>;
 
 type APIResponseProps = {
@@ -48,8 +67,8 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
   }
 
   const contentType = response.headers.get('content-type');
-  const isJSON =
-    contentType?.includes('application/json') || contentType?.includes('application/vnd.api+json');
+  const mediaType = contentType?.split(';')[0]?.trim();
+  const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
   if (isJSON) {
     const json = await response.json();
 
@@ -151,6 +170,7 @@ export class APIPromise<T> extends Promise<T> {
 
 export abstract class APIClient {
   baseURL: string;
+  #baseURLOverridden: boolean;
   maxRetries: number;
   timeout: number;
   httpAgent: Agent | undefined;
@@ -160,18 +180,21 @@ export abstract class APIClient {
 
   constructor({
     baseURL,
+    baseURLOverridden,
     maxRetries = 2,
     timeout = 60000, // 1 minute
     httpAgent,
     fetch: overriddenFetch,
   }: {
     baseURL: string;
+    baseURLOverridden: boolean;
     maxRetries?: number | undefined;
     timeout: number | undefined;
     httpAgent: Agent | undefined;
     fetch: Fetch | undefined;
   }) {
     this.baseURL = baseURL;
+    this.#baseURLOverridden = baseURLOverridden;
     this.maxRetries = validatePositiveInteger('maxRetries', maxRetries);
     this.timeout = validatePositiveInteger('timeout', timeout);
     this.httpAgent = httpAgent;
@@ -194,7 +217,7 @@ export abstract class APIClient {
   protected defaultHeaders(opts: FinalRequestOptions): Headers {
     return {
       Accept: 'application/json',
-      'Content-Type': 'application/json',
+      ...(['head', 'get'].includes(opts.method) ? {} : { 'Content-Type': 'application/json' }),
       'User-Agent': this.getUserAgent(),
       ...getPlatformHeaders(),
       ...this.authHeaders(opts),
@@ -276,11 +299,12 @@ export abstract class APIClient {
     return null;
   }
 
-  buildRequest<Req>(
-    options: FinalRequestOptions<Req>,
+  async buildRequest<Req>(
+    inputOptions: FinalRequestOptions<Req>,
     { retryCount = 0 }: { retryCount?: number } = {},
-  ): { req: RequestInit; url: string; timeout: number } {
-    const { method, path, query, headers: headers = {} } = options;
+  ): Promise<{ req: RequestInit; url: string; timeout: number }> {
+    const options = { ...inputOptions };
+    const { method, path, query, defaultBaseURL, headers: headers = {} } = options;
 
     const body =
       ArrayBuffer.isView(options.body) || (options.__binaryRequest && typeof options.body === 'string') ?
@@ -290,11 +314,11 @@ export abstract class APIClient {
       : null;
     const contentLength = this.calculateContentLength(body);
 
-    const url = this.buildURL(path!, query);
+    const url = this.buildURL(path!, query, defaultBaseURL);
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
-    const timeout = options.timeout ?? this.timeout;
+    options.timeout = options.timeout ?? this.timeout;
     const httpAgent = options.httpAgent ?? this.httpAgent ?? getDefaultAgent(url);
-    const minAgentTimeout = timeout + 1000;
+    const minAgentTimeout = options.timeout + 1000;
     if (
       typeof (httpAgent as any)?.options?.timeout === 'number' &&
       minAgentTimeout > ((httpAgent as any).options.timeout ?? 0)
@@ -307,8 +331,8 @@ export abstract class APIClient {
     }
 
     if (this.idempotencyHeader && method !== 'get') {
-      if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
-      headers[this.idempotencyHeader] = options.idempotencyKey;
+      if (!inputOptions.idempotencyKey) inputOptions.idempotencyKey = this.defaultIdempotencyKey();
+      headers[this.idempotencyHeader] = inputOptions.idempotencyKey;
     }
 
     const reqHeaders = this.buildHeaders({ options, headers, contentLength, retryCount });
@@ -323,7 +347,7 @@ export abstract class APIClient {
       signal: options.signal ?? null,
     };
 
-    return { req, url, timeout };
+    return { req, url, timeout: options.timeout };
   }
 
   private buildHeaders({
@@ -351,15 +375,22 @@ export abstract class APIClient {
       delete reqHeaders['content-type'];
     }
 
-    // Don't set the retry count header if it was already set or removed through default headers or by the
-    // caller. We check `defaultHeaders` and `headers`, which can contain nulls, instead of `reqHeaders` to
-    // account for the removal case.
+    // Don't set theses headers if they were already set or removed through default headers or by the caller.
+    // We check `defaultHeaders` and `headers`, which can contain nulls, instead of `reqHeaders` to account
+    // for the removal case.
     if (
       getHeader(defaultHeaders, 'x-stainless-retry-count') === undefined &&
       getHeader(headers, 'x-stainless-retry-count') === undefined
     ) {
       reqHeaders['x-stainless-retry-count'] = String(retryCount);
     }
+    if (
+      getHeader(defaultHeaders, 'x-stainless-timeout') === undefined &&
+      getHeader(headers, 'x-stainless-timeout') === undefined &&
+      options.timeout
+    ) {
+      reqHeaders['x-stainless-timeout'] = String(Math.trunc(options.timeout / 1000));
+    }
 
     this.validateHeaders(reqHeaders, headers);
 
@@ -387,7 +418,7 @@ export abstract class APIClient {
       !headers ? {}
       : Symbol.iterator in headers ?
         Object.fromEntries(Array.from(headers as Iterable<string[]>).map((header) => [...header]))
-      : { ...headers }
+      : { ...(headers as any as Record<string, string>) }
     );
   }
 
@@ -419,7 +450,9 @@ export abstract class APIClient {
 
     await this.prepareOptions(options);
 
-    const { req, url, timeout } = this.buildRequest(options, { retryCount: maxRetries - retriesRemaining });
+    const { req, url, timeout } = await this.buildRequest(options, {
+      retryCount: maxRetries - retriesRemaining,
+    });
 
     await this.prepareRequest(req, { url, options });
 
@@ -476,11 +509,12 @@ export abstract class APIClient {
     return new PagePromise<PageClass, Item>(this, request, Page);
   }
 
-  buildURL<Req>(path: string, query: Req | null | undefined): string {
+  buildURL<Req>(path: string, query: Req | null | undefined, defaultBaseURL?: string | undefined): string {
+    const baseURL = (!this.#baseURLOverridden && defaultBaseURL) || this.baseURL;
     const url =
       isAbsoluteURL(path) ?
         new URL(path)
-      : new URL(this.baseURL + (this.baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
+      : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
     if (!isEmptyObj(defaultQuery)) {
@@ -765,6 +799,7 @@ export type RequestOptions<
   query?: Req | undefined;
   body?: Req | null | undefined;
   headers?: Headers | undefined;
+  defaultBaseURL?: string | undefined;
 
   maxRetries?: number;
   stream?: boolean | undefined;
@@ -786,6 +821,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   query: true,
   body: true,
   headers: true,
+  defaultBaseURL: true,
 
   maxRetries: true,
   stream: true,

package/src/index.ts

@@ -6,18 +6,44 @@ import * as Core from './core';
 import * as Errors from './error';
 import * as Uploads from './uploads';
 import * as API from './resources/index';
-import { AssetCreateParams, AssetCreateResponse, Assets } from './resources/assets';
-import { AuctionBidCreateParams, AuctionBidListParams, AuctionBids } from './resources/auction-bids';
+import { AssetCreateAssetParams, AssetCreateAssetResponse, Assets } from './resources/assets';
+import { Auth, AuthConnectAuthParams, AuthConnectAuthResponse } from './resources/auth';
+import { Minting, MintingGetAssetsParams, MintingGetAssetsResponse } from './resources/minting';
+import {
+  AuctionGetPageSectionsParams,
+  AuctionGetPageSectionsResponse,
+  AuctionListAuctionBidsParams,
+  AuctionListAuctionsResponse,
+  Auctions,
+} from './resources/auctions/auctions';
+import { Loyalty } from './resources/loyalty/loyalty';
+import {
+  Referral,
+  ReferralCreateCodeParams,
+  ReferralCreateCodeResponse,
+} from './resources/referral/referral';
+import {
+  UserConnectParams,
+  UserConnectResponse,
+  UserCountParams,
+  UserCountResponse,
+  UserCreateDeviceParams,
+  UserCreateDeviceResponse,
+  UserDisconnectParams,
+  UserDisconnectResponse,
+  UserListParams,
+  UserListResponse,
+  UserVerifyParams,
+  UserVerifyResponse,
+  Users,
+} from './resources/users/users';
 import {
   WebsiteCreateParams,
   WebsiteCreateResponse,
   WebsiteListParams,
   WebsiteListResponse,
   Websites,
-} from './resources/websites';
-import { Drip } from './resources/drip/drip';
-import { Loyalty } from './resources/loyalty/loyalty';
-import { Users } from './resources/users/users';
+} from './resources/websites/websites';
 
 export interface ClientOptions {
   /**
@@ -38,8 +64,10 @@ export interface ClientOptions {
    *
    * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
    * much longer than this timeout before the promise succeeds or fails.
+   *
+   * @unit milliseconds
    */
-  timeout?: number;
+  timeout?: number | undefined;
 
   /**
    * An HTTP agent used to manage HTTP(S) connections.
@@ -47,7 +75,7 @@ export interface ClientOptions {
    * If not provided, an agent will be constructed by default in the Node.js environment,
    * otherwise no agent is used.
    */
-  httpAgent?: Agent;
+  httpAgent?: Agent | undefined;
 
   /**
    * Specify a custom `fetch` function implementation.
@@ -63,7 +91,7 @@ export interface ClientOptions {
    *
    * @default 2
    */
-  maxRetries?: number;
+  maxRetries?: number | undefined;
 
   /**
    * Default headers to include with every request to the API.
@@ -71,7 +99,7 @@ export interface ClientOptions {
    * These can be removed in individual requests by explicitly setting the
    * header to `undefined` or `null` in request options.
    */
-  defaultHeaders?: Core.Headers;
+  defaultHeaders?: Core.Headers | undefined;
 
   /**
    * Default query parameters to include with every request to the API.
@@ -79,7 +107,7 @@ export interface ClientOptions {
    * These can be removed in individual requests by explicitly setting the
    * param to `undefined` in request options.
    */
-  defaultQuery?: Core.DefaultQuery;
+  defaultQuery?: Core.DefaultQuery | undefined;
 }
 
 /**
@@ -121,6 +149,7 @@ export class SnagSolutions extends Core.APIClient {
 
     super({
       baseURL: options.baseURL!,
+      baseURLOverridden: baseURL ? baseURL !== 'https://admin.snagsolutions.io/' : false,
       timeout: options.timeout ?? 60000 /* 1 minute */,
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
@@ -133,11 +162,20 @@ export class SnagSolutions extends Core.APIClient {
   }
 
   assets: API.Assets = new API.Assets(this);
+  auth: API.Auth = new API.Auth(this);
+  auctions: API.Auctions = new API.Auctions(this);
   users: API.Users = new API.Users(this);
   loyalty: API.Loyalty = new API.Loyalty(this);
-  auctionBids: API.AuctionBids = new API.AuctionBids(this);
+  minting: API.Minting = new API.Minting(this);
+  referral: API.Referral = new API.Referral(this);
   websites: API.Websites = new API.Websites(this);
-  drip: API.Drip = new API.Drip(this);
+
+  /**
+   * Check whether the base URL is set to its default.
+   */
+  #baseURLOverridden(): boolean {
+    return this.baseURL !== 'https://admin.snagsolutions.io/';
+  }
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
@@ -155,7 +193,7 @@ export class SnagSolutions extends Core.APIClient {
   }
 
   protected override stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'comma' });
+    return qs.stringify(query, { arrayFormat: 'repeat' });
   }
 
   static SnagSolutions = this;
@@ -180,28 +218,64 @@ export class SnagSolutions extends Core.APIClient {
 }
 
 SnagSolutions.Assets = Assets;
+SnagSolutions.Auth = Auth;
+SnagSolutions.Auctions = Auctions;
 SnagSolutions.Users = Users;
 SnagSolutions.Loyalty = Loyalty;
-SnagSolutions.AuctionBids = AuctionBids;
+SnagSolutions.Minting = Minting;
+SnagSolutions.Referral = Referral;
 SnagSolutions.Websites = Websites;
-SnagSolutions.Drip = Drip;
 export declare namespace SnagSolutions {
   export type RequestOptions = Core.RequestOptions;
 
   export {
     Assets as Assets,
-    type AssetCreateResponse as AssetCreateResponse,
-    type AssetCreateParams as AssetCreateParams,
+    type AssetCreateAssetResponse as AssetCreateAssetResponse,
+    type AssetCreateAssetParams as AssetCreateAssetParams,
+  };
+
+  export {
+    Auth as Auth,
+    type AuthConnectAuthResponse as AuthConnectAuthResponse,
+    type AuthConnectAuthParams as AuthConnectAuthParams,
   };
 
-  export { Users as Users };
+  export {
+    Auctions as Auctions,
+    type AuctionGetPageSectionsResponse as AuctionGetPageSectionsResponse,
+    type AuctionListAuctionsResponse as AuctionListAuctionsResponse,
+    type AuctionGetPageSectionsParams as AuctionGetPageSectionsParams,
+    type AuctionListAuctionBidsParams as AuctionListAuctionBidsParams,
+  };
+
+  export {
+    Users as Users,
+    type UserListResponse as UserListResponse,
+    type UserConnectResponse as UserConnectResponse,
+    type UserCountResponse as UserCountResponse,
+    type UserCreateDeviceResponse as UserCreateDeviceResponse,
+    type UserDisconnectResponse as UserDisconnectResponse,
+    type UserVerifyResponse as UserVerifyResponse,
+    type UserListParams as UserListParams,
+    type UserConnectParams as UserConnectParams,
+    type UserCountParams as UserCountParams,
+    type UserCreateDeviceParams as UserCreateDeviceParams,
+    type UserDisconnectParams as UserDisconnectParams,
+    type UserVerifyParams as UserVerifyParams,
+  };
 
   export { Loyalty as Loyalty };
 
   export {
-    AuctionBids as AuctionBids,
-    type AuctionBidCreateParams as AuctionBidCreateParams,
-    type AuctionBidListParams as AuctionBidListParams,
+    Minting as Minting,
+    type MintingGetAssetsResponse as MintingGetAssetsResponse,
+    type MintingGetAssetsParams as MintingGetAssetsParams,
+  };
+
+  export {
+    Referral as Referral,
+    type ReferralCreateCodeResponse as ReferralCreateCodeResponse,
+    type ReferralCreateCodeParams as ReferralCreateCodeParams,
   };
 
   export {
@@ -211,8 +285,6 @@ export declare namespace SnagSolutions {
     type WebsiteCreateParams as WebsiteCreateParams,
     type WebsiteListParams as WebsiteListParams,
   };
-
-  export { Drip as Drip };
 }
 
 export { toFile, fileFromPath } from './uploads';

package/src/resource.ts

@@ -2,7 +2,7 @@
 
 import type { SnagSolutions } from './index';
 
-export class APIResource {
+export abstract class APIResource {
   protected _client: SnagSolutions;
 
   constructor(client: SnagSolutions) {

package/src/resources/assets.ts

@@ -5,11 +5,22 @@ import * as Core from '../core';
 
 export class Assets extends APIResource {
   /**
-   * This endpoint allows you to upload a file to the resource. returns a presigned
-   * URL and the asset's public URL call put with the file as the body to upload the
-   * asst
+   * This endpoint enables you to upload a file to the resource. Returns a presigned
+   * URL and the asset's public URL. Call PUT with the file as the body to upload the
+   * asset using the presigned URL.
+   *
+   * @example
+   * ```ts
+   * const response = await client.assets.createAsset({
+   *   fileName: 'example.png',
+   *   fileSize: 1024,
+   * });
+   * ```
    */
-  create(body: AssetCreateParams, options?: Core.RequestOptions): Core.APIPromise<AssetCreateResponse> {
+  createAsset(
+    body: AssetCreateAssetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AssetCreateAssetResponse> {
     return this._client.post('/api/assets', { body, ...options });
   }
 }
@@ -18,7 +29,7 @@ export class Assets extends APIResource {
  * Response returned upon successful generation of the signed URL for uploading the
  * file.
  */
-export interface AssetCreateResponse {
+export interface AssetCreateAssetResponse {
   /**
    * The pre-signed URL to be used for uploading the file.
    */
@@ -30,12 +41,19 @@ export interface AssetCreateResponse {
   url: string;
 }
 
-export interface AssetCreateParams {
+export interface AssetCreateAssetParams {
   /**
-   * The name of the file, must match the regex pattern (converted to lowercase)
+   * The name of the file, must match the regex pattern (converted to lowercase) and
+   * have a valid extension.
    */
   fileName: string;
 
+  /**
+   * Size of the file in bytes. Uploaded file must match this file size. 1mb for
+   * images and 10mb for videos.
+   */
+  fileSize: number;
+
   /**
    * The file path, must be a valid enum value.
    */
@@ -67,5 +85,8 @@ export interface AssetCreateParams {
 }
 
 export declare namespace Assets {
-  export { type AssetCreateResponse as AssetCreateResponse, type AssetCreateParams as AssetCreateParams };
+  export {
+    type AssetCreateAssetResponse as AssetCreateAssetResponse,
+    type AssetCreateAssetParams as AssetCreateAssetParams,
+  };
 }