TypeScript declarations

Describe the problem you’d like to have solved

There are no TypeScript declarations for this package! We want to use it programmatically with TypeScript but this is difficult without types.

Describe the ideal solution

It would be nice to include declarations alongside the npm package, or they can be added to https://github.com/DefinitelyTyped/DefinitelyTyped under @types/auth0-deploy-cli

Alternatives and current work-arounds

Currently, we just have declare module 'auth0-deploy-cli'; which is basically just turning off type-checking for the library

[willvedd]

Good news folks, this has been added in our 7.8.0 release! I tested this quite a bit and believe it to cover most folks’ use cases, but it may not be 100% perfect. Would be great to have folks give it a go and provide some feedback.

Samples:

import { dump, deploy } from 'auth0-deploy-cli';

await dump({
      output_folder: "./output",
      format: "yaml",
      config: {
        AUTH0_DOMAIN: "<YOUR_DOMAIN>",
        AUTH0_CLIENT_ID: "<YOUR_CLIENT_ID>",
        AUTH0_CLIENT_SECRET: "<YOUR_CLIENT_SECRET>"
   }
});

and

import { dump, deploy } from 'auth0-deploy-cli';

await deploy({
      input_file: "./output/tenant.yaml",
      config: {
        AUTH0_DOMAIN: "<YOUR_DOMAIN>",
        AUTH0_CLIENT_ID: "<YOUR_CLIENT_ID>",
        AUTH0_CLIENT_SECRET: "<YOUR_CLIENT_SECRET>"
    }
});

I’m going to close but please feel empowered to provide feedback regarding refinement and fixes with new issues.

[mikestopcontinues]

Ditto here. Using it programmatically helps me keep a bunch of params in sync across aws-cdk, vercel env vars, paddle products, and auth0 config. I’ve got types for everything else, either because they’re provided or because I typed the API endpoints I use.