Permify TypeScript Client

Common errors

Warnings

Install

Imports

• permify (all exports)
  wrong

  const permify = require('permify-typescript');

  correct

  import * as permify from 'permify-typescript';

  CommonJS `require` might work with transpilation, but this library is primarily designed for ESM with Node.js >=18, aligning with modern TypeScript best practices.

• Configuration, TenancyApi, PermissionApi
  wrong

  import Configuration from 'permify-typescript/Configuration';

  correct

  import { Configuration, TenancyApi, PermissionApi } from 'permify-typescript';

  API client classes, configuration, and most models are exported as named exports directly from the package root.

• Tenant (type)
  wrong

  import { Tenant } from 'permify-typescript';

  correct

  import type { Tenant } from 'permify-typescript';

  Use `import type` for importing only type definitions in TypeScript for better bundle optimization and clarity, as `Tenant` is a type definition for an API model.

Quickstart

This quickstart demonstrates how to initialize the Permify TypeScript client, configure it with a base path and an authorization header using environment variables, and then create a new tenant using the TenancyApi client.

import * as permify from "permify-typescript";

// Configure the client with your Permify API base path and authorization token.
// It's recommended to use environment variables for sensitive data.
const configuration = new permify.Configuration({
    basePath: process.env.PERMIFY_API_BASE_PATH ?? "http://localhost:3476",
    headers: {
        'Authorization': process.env.PERMIFY_API_KEY ? `Bearer ${process.env.PERMIFY_API_KEY}` : ""
    }
});

// Initialize the TenancyApi to interact with tenant-related endpoints.
const apiInstance = new permify.TenancyApi(configuration);

// Define a tenant ID, perhaps from a database or a unique identifier.
let tenantId = "example_tenant_id"; 

// Create a new tenant in Permify.
apiInstance.tenantsCreate({
    body: {
        id: tenantId,
        name: "Example Tenant"
    }
})
.then((data) => {
    console.log('API called successfully. Created tenant: ' + JSON.stringify(data.tenant));
})
.catch((error) => {
    console.error('Error creating tenant:', error.response?.data || error.message);
});