dub 0.1.0 → 0.2.0

package/resources/projects/tags.js

@@ -7,13 +7,15 @@ class Tags extends resource_1.APIResource {
     /**
      * Create a new tag for the authenticated project.
      */
-    create(projectSlug, body, options) {
+    create(params, options) {
+        const { projectSlug = this._client.projectSlug, ...body } = params;
         return this._client.post(`/projects/${projectSlug}/tags`, { body, ...options });
     }
     /**
      * Retrieve a list of tags for the authenticated project.
      */
-    list(projectSlug, options) {
+    list(params, options) {
+        const { projectSlug = this._client.projectSlug } = params;
         return this._client.get(`/projects/${projectSlug}/tags`, options);
     }
 }

package/resources/projects/tags.js.map

@@ -1 +1 @@
-{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/resources/projects/tags.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2CAA2C;AAG3C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,MAAM,CAAC,WAAmB,EAAE,IAAqB,EAAE,OAA6B;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,WAAW,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,WAAmB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,WAAW,OAAO,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AAdD,oBAcC;AA4BD,WAAiB,IAAI;AAIrB,CAAC,EAJgB,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAIpB"}
+{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/resources/projects/tags.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2CAA2C;AAG3C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,MAAM,CAAC,MAAuB,EAAE,OAA6B;QAC3D,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,WAAW,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,MAAqB,EAAE,OAA6B;QACvD,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,WAAW,OAAO,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AAhBD,oBAgBC;AA0CD,WAAiB,IAAI;AAKrB,CAAC,EALgB,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAKpB"}

package/resources/projects/tags.mjs

@@ -4,13 +4,15 @@ export class Tags extends APIResource {
     /**
      * Create a new tag for the authenticated project.
      */
-    create(projectSlug, body, options) {
+    create(params, options) {
+        const { projectSlug = this._client.projectSlug, ...body } = params;
         return this._client.post(`/projects/${projectSlug}/tags`, { body, ...options });
     }
     /**
      * Retrieve a list of tags for the authenticated project.
      */
-    list(projectSlug, options) {
+    list(params, options) {
+        const { projectSlug = this._client.projectSlug } = params;
         return this._client.get(`/projects/${projectSlug}/tags`, options);
     }
 }

package/resources/projects/tags.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"tags.mjs","sourceRoot":"","sources":["../../src/resources/projects/tags.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,cAAc;AAG1C,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,MAAM,CAAC,WAAmB,EAAE,IAAqB,EAAE,OAA6B;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,WAAW,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,WAAmB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,WAAW,OAAO,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AA4BD,WAAiB,IAAI;AAIrB,CAAC,EAJgB,IAAI,KAAJ,IAAI,QAIpB"}
+{"version":3,"file":"tags.mjs","sourceRoot":"","sources":["../../src/resources/projects/tags.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,cAAc;AAG1C,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,MAAM,CAAC,MAAuB,EAAE,OAA6B;QAC3D,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,WAAW,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,MAAqB,EAAE,OAA6B;QACvD,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,WAAW,OAAO,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACF;AA0CD,WAAiB,IAAI;AAKrB,CAAC,EALgB,IAAI,KAAJ,IAAI,QAKpB"}

package/src/core.ts

@@ -443,8 +443,8 @@ export abstract class APIClient {
       query = { ...defaultQuery, ...query } as Req;
     }
 
-    if (query) {
-      url.search = this.stringifyQuery(query);
+    if (typeof query === 'object' && query && !Array.isArray(query)) {
+      url.search = this.stringifyQuery(query as Record<string, unknown>);
     }
 
     return url.toString();
@@ -952,14 +952,16 @@ export const ensurePresent = <T>(value: T | null | undefined): T => {
 /**
  * Read an environment variable.
  *
+ * Trims beginning and trailing whitespace.
+ *
  * Will return undefined if the environment variable doesn't exist or cannot be accessed.
  */
 export const readEnv = (env: string): string | undefined => {
   if (typeof process !== 'undefined') {
-    return process.env?.[env] ?? undefined;
+    return process.env?.[env]?.trim() ?? undefined;
   }
   if (typeof Deno !== 'undefined') {
-    return Deno.env?.get?.(env);
+    return Deno.env?.get?.(env)?.trim();
   }
   return undefined;
 };

package/src/index.ts

@@ -8,9 +8,11 @@ import * as API from "./resources/index";
 
 export interface ClientOptions {
   /**
-   * Defaults to process.env['DUB_BEARER_TOKEN'].
+   * Defaults to process.env['DUB_API_KEY'].
    */
-  bearerToken?: string;
+  token?: string;
+
+  projectSlug?: string | null;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
@@ -71,14 +73,16 @@ export interface ClientOptions {
 
 /** API Client for interfacing with the Dub API. */
 export class Dub extends Core.APIClient {
-  bearerToken: string;
+  token: string;
+  projectSlug: string | null;
 
   private _options: ClientOptions;
 
   /**
    * API Client for interfacing with the Dub API.
    *
-   * @param {string} [opts.bearerToken=process.env['DUB_BEARER_TOKEN'] ?? undefined]
+   * @param {string} [opts.token=process.env['DUB_API_KEY'] ?? undefined]
+   * @param {string | null} [opts.projectSlug]
    * @param {string} [opts.baseURL=process.env['DUB_BASE_URL'] ?? https://api.dub.co] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
@@ -89,19 +93,21 @@ export class Dub extends Core.APIClient {
    */
   constructor({
     baseURL = Core.readEnv('DUB_BASE_URL'),
-    bearerToken = Core.readEnv('DUB_BEARER_TOKEN'),
+    token = Core.readEnv('DUB_API_KEY'),
+    projectSlug = null,
     ...opts
   }: ClientOptions = {}) {
-    if (bearerToken === undefined) {
+    if (token === undefined) {
       throw new Errors.DubError(
-        "The DUB_BEARER_TOKEN environment variable is missing or empty; either provide it, or instantiate the Dub client with an bearerToken option, like new Dub({ bearerToken: 'My Bearer Token' }).",
+        "The DUB_API_KEY environment variable is missing or empty; either provide it, or instantiate the Dub client with an token option, like new Dub({ token: 'My Token' }).",
       );
     }
 
     const options: ClientOptions = {
-      bearerToken,
+      token,
+      projectSlug,
       ...opts,
-      baseURL: baseURL ?? `https://api.dub.co`,
+      baseURL: baseURL || `https://api.dub.co`,
     };
 
     super({
@@ -113,7 +119,8 @@ export class Dub extends Core.APIClient {
     });
     this._options = options;
 
-    this.bearerToken = bearerToken;
+    this.token = token;
+    this.projectSlug = projectSlug;
   }
 
   links: API.Links = new API.Links(this);
@@ -131,7 +138,7 @@ export class Dub extends Core.APIClient {
   }
 
   protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
-    return { Authorization: `Bearer ${this.bearerToken}` };
+    return { Authorization: `Bearer ${this.token}` };
   }
 
   static Dub = this;
@@ -188,6 +195,7 @@ export namespace Dub {
   export import Project = API.Project;
   export import ProjectDetails = API.ProjectDetails;
   export import ProjectListResponse = API.ProjectListResponse;
+  export import ProjectRetrieveParams = API.ProjectRetrieveParams;
 
   export import Link = API.Link;
 }

package/src/resources/index.ts

@@ -9,4 +9,10 @@ export {
   LinkDeleteParams,
   Links,
 } from './links/links';
-export { Project, ProjectDetails, ProjectListResponse, Projects } from './projects/projects';
+export {
+  Project,
+  ProjectDetails,
+  ProjectListResponse,
+  ProjectRetrieveParams,
+  Projects,
+} from './projects/projects';

package/src/resources/links/bulk.ts

@@ -10,7 +10,7 @@ export class Bulk extends APIResource {
    * Bulk create up to 100 links for the authenticated project.
    */
   create(params: BulkCreateParams, options?: Core.RequestOptions): Core.APIPromise<BulkCreateResponse> {
-    const { projectSlug, ...body } = params;
+    const { projectSlug = this._client.projectSlug, ...body } = params;
     return this._client.post('/links/bulk', { query: { projectSlug }, body, ...options });
   }
 }
@@ -22,7 +22,7 @@ export interface BulkCreateParams {
    * Query param: The slug for the project to create links for. E.g. for
    * app.dub.co/acme, the projectSlug is 'acme'.
    */
-  projectSlug: string;
+  projectSlug?: string;
 }
 
 export namespace BulkCreateParams {

package/src/resources/links/info.ts

@@ -9,8 +9,9 @@ export class Info extends APIResource {
   /**
    * Retrieve the info for a link from their domain and key.
    */
-  retrieve(query: InfoRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Link> {
-    return this._client.get('/links/info', { query, ...options });
+  retrieve(params: InfoRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Link> {
+    const { projectSlug = this._client.projectSlug, ...query } = params;
+    return this._client.get('/links/info', { query: { projectSlug, ...query }, ...options });
   }
 }
 
@@ -30,7 +31,7 @@ export interface InfoRetrieveParams {
    * The slug for the project that the link belongs to. E.g. for app.dub.co/acme, the
    * projectSlug is 'acme'.
    */
-  projectSlug: string;
+  projectSlug?: string;
 }
 
 export namespace Info {

package/src/resources/links/links.ts

@@ -15,7 +15,7 @@ export class Links extends APIResource {
    * Create a new link for the authenticated project.
    */
   create(params: LinkCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Link> {
-    const { projectSlug, ...body } = params;
+    const { projectSlug = this._client.projectSlug, ...body } = params;
     return this._client.post('/links', { query: { projectSlug }, body, ...options });
   }
 
@@ -27,7 +27,7 @@ export class Links extends APIResource {
     params: LinkUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<Shared.Link> {
-    const { projectSlug, ...body } = params;
+    const { projectSlug = this._client.projectSlug, ...body } = params;
     return this._client.put(`/links/${linkId}`, { query: { projectSlug }, body, ...options });
   }
 
@@ -35,8 +35,9 @@ export class Links extends APIResource {
    * Retrieve a list of links for the authenticated project. The list will be
    * paginated and the provided query parameters allow filtering the returned links.
    */
-  list(query: LinkListParams, options?: Core.RequestOptions): Core.APIPromise<LinkListResponse> {
-    return this._client.get('/links', { query, ...options });
+  list(params: LinkListParams, options?: Core.RequestOptions): Core.APIPromise<LinkListResponse> {
+    const { projectSlug = this._client.projectSlug, ...query } = params;
+    return this._client.get('/links', { query: { projectSlug, ...query }, ...options });
   }
 
   /**
@@ -47,7 +48,7 @@ export class Links extends APIResource {
     params: LinkDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<Shared.Link> {
-    const { projectSlug } = params;
+    const { projectSlug = this._client.projectSlug } = params;
     return this._client.delete(`/links/${linkId}`, { query: { projectSlug }, ...options });
   }
 }
@@ -59,7 +60,7 @@ export interface LinkCreateParams {
    * Query param: The slug for the project to create links for. E.g. for
    * app.dub.co/acme, the projectSlug is 'acme'.
    */
-  projectSlug: string;
+  projectSlug?: string;
 
   /**
    * Body param: The domain of the short link.
@@ -160,7 +161,7 @@ export interface LinkUpdateParams {
    * Query param: The slug for the project that the link belongs to. E.g. for
    * app.dub.co/acme, the projectSlug is 'acme'.
    */
-  projectSlug: string;
+  projectSlug?: string;
 
   /**
    * Body param: The Android destination URL for the short link for Android device
@@ -261,7 +262,7 @@ export interface LinkListParams {
    * The slug for the project to retrieve links for. E.g. for app.dub.co/acme, the
    * projectSlug is 'acme'.
    */
-  projectSlug: string;
+  projectSlug?: string;
 
   /**
    * The domain to filter the links by. E.g. 'ac.me'. If not provided, all links for
@@ -308,7 +309,7 @@ export interface LinkDeleteParams {
    * The slug for the project that the link belongs to. E.g. for app.dub.co/acme, the
    * projectSlug is 'acme'.
    */
-  projectSlug: string;
+  projectSlug?: string;
 }
 
 export namespace Links {

package/src/resources/projects/index.ts

@@ -1,4 +1,4 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { Project, ProjectDetails, ProjectListResponse, Projects } from './projects';
-export { Tag, TagListResponse, TagCreateParams, Tags } from './tags';
+export { Project, ProjectDetails, ProjectListResponse, ProjectRetrieveParams, Projects } from './projects';
+export { Tag, TagListResponse, TagCreateParams, TagListParams, Tags } from './tags';

package/src/resources/projects/projects.ts

@@ -11,7 +11,8 @@ export class Projects extends APIResource {
   /**
    * Retrieve a project for the authenticated user.
    */
-  retrieve(projectSlug: string, options?: Core.RequestOptions): Core.APIPromise<ProjectDetails> {
+  retrieve(params: ProjectRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<ProjectDetails> {
+    const { projectSlug = this._client.projectSlug } = params;
     return this._client.get(`/projects/${projectSlug}`, options);
   }
 
@@ -111,12 +112,22 @@ export namespace ProjectDetails {
 
 export type ProjectListResponse = Array<Project>;
 
+export interface ProjectRetrieveParams {
+  /**
+   * The slug for the project to retrieve. E.g. for app.dub.co/acme, the projectSlug
+   * is 'acme'.
+   */
+  projectSlug?: string;
+}
+
 export namespace Projects {
   export import Project = ProjectsAPI.Project;
   export import ProjectDetails = ProjectsAPI.ProjectDetails;
   export import ProjectListResponse = ProjectsAPI.ProjectListResponse;
+  export import ProjectRetrieveParams = ProjectsAPI.ProjectRetrieveParams;
   export import Tags = TagsAPI.Tags;
   export import Tag = TagsAPI.Tag;
   export import TagListResponse = TagsAPI.TagListResponse;
   export import TagCreateParams = TagsAPI.TagCreateParams;
+  export import TagListParams = TagsAPI.TagListParams;
 }

package/src/resources/projects/tags.ts

@@ -8,14 +8,16 @@ export class Tags extends APIResource {
   /**
    * Create a new tag for the authenticated project.
    */
-  create(projectSlug: string, body: TagCreateParams, options?: Core.RequestOptions): Core.APIPromise<Tag> {
+  create(params: TagCreateParams, options?: Core.RequestOptions): Core.APIPromise<Tag> {
+    const { projectSlug = this._client.projectSlug, ...body } = params;
     return this._client.post(`/projects/${projectSlug}/tags`, { body, ...options });
   }
 
   /**
    * Retrieve a list of tags for the authenticated project.
    */
-  list(projectSlug: string, options?: Core.RequestOptions): Core.APIPromise<TagListResponse> {
+  list(params: TagListParams, options?: Core.RequestOptions): Core.APIPromise<TagListResponse> {
+    const { projectSlug = this._client.projectSlug } = params;
     return this._client.get(`/projects/${projectSlug}/tags`, options);
   }
 }
@@ -41,13 +43,28 @@ export type TagListResponse = Array<Tag>;
 
 export interface TagCreateParams {
   /**
-   * The name of the tag to create.
+   * Path param: The slug for the project to create tags for. E.g. for
+   * app.dub.co/acme, the projectSlug is 'acme'.
+   */
+  projectSlug?: string;
+
+  /**
+   * Body param: The name of the tag to create.
    */
   tag?: string;
 }
 
+export interface TagListParams {
+  /**
+   * The slug for the project to retrieve tags for. E.g. for app.dub.co/acme, the
+   * projectSlug is 'acme'.
+   */
+  projectSlug?: string;
+}
+
 export namespace Tags {
   export import Tag = TagsAPI.Tag;
   export import TagListResponse = TagsAPI.TagListResponse;
   export import TagCreateParams = TagsAPI.TagCreateParams;
+  export import TagListParams = TagsAPI.TagListParams;
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0'; // x-release-please-version
+export const VERSION = '0.2.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.2.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0'; // x-release-please-version
+exports.VERSION = '0.2.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0'; // x-release-please-version
+export const VERSION = '0.2.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map