@shipengine/connect-fulfillment-provider-api 0.1.0 → 0.2.1

package/README.md

@@ -1,3 +1,18 @@
 # Fulfillment Provider API TypeScript Library
 
-This library contains types used in building ShipEngine Connect Fulfillment Provider apps - the requests, responses, and models used to implement the Fulfillment Provider API.
+The purpose of this library is to provide a framework for integrating Fulfillment Providers into the network using JavaScript & TypeScript. It will contain the models and definitions for Request/Response Bodies.
+
+## Building & Publishing
+To build the project use this command in the terminal from this directory.
+```
+yarn build
+```
+
+this will generate a ```./lib``` directory which contains the JavaScript & TypeScript.
+
+To publish make sure you set the appropriate version in the package.json file and then:
+```
+yarn build
+yarn publish
+```
+

package/lib/app/fulfillment-provider-app-definition.d.ts

@@ -1,6 +1,6 @@
 import { FulfillmentProviderAppMetadata } from './fulfillment-provider-app-metadata';
-import { ConnectRequest, ReconnectRequest, DelegationRequest, StatusRequest, CancellationRequest, InventoryRequest, GetRatesRequest, GetRecentChangesRequest } from '..';
-import { ConnectResponse, ReconnectResponse, DelegationResponse, StatusResponse, CancellationResponse, InventoryResponse, GetRatesResponse, GetRecentChangesResponse } from '..';
+import { ConnectRequest, DelegationRequest, StatusRequest, CancellationRequest, GetRatesRequest, GetRecentChangesRequest } from '..';
+import { ConnectResponse, DelegationResponse, StatusResponse, CancellationResponse, GetRatesResponse, GetRecentChangesResponse } from '..';
 /**
  * Definition for an Fulfillment Provider App implementation
  */
@@ -10,10 +10,6 @@ export interface FulfillmentProviderAppDefinition {
      * Create a connection to a fulfillment provider.
      */
     connect: (request: ConnectRequest) => Promise<ConnectResponse>;
-    /**
-     * Refresh connection details for a connection.
-     */
-    reconnect: (request: ReconnectRequest) => Promise<ReconnectResponse>;
     /**
      * Delegate a fulfillment to a provider.
      */
@@ -26,10 +22,6 @@ export interface FulfillmentProviderAppDefinition {
      * Request that a delegated fulfillment be cancelled by the provider.
      */
     requestCancellation: (request: CancellationRequest) => Promise<CancellationResponse>;
-    /**
-     * Get paged results of inventory from the provider.
-     */
-    getInventory: (request: InventoryRequest) => Promise<InventoryResponse>;
     /**
      * Get rates for a fulfillment preview from a provider.
      */

package/lib/app/fulfillment-provider-app-metadata.d.ts

@@ -3,6 +3,8 @@ export declare type FulfillmentProviderAppMetadata = {
     Id: string;
     /** @description The name of this integration */
     Name: string;
+    /** @description The specification for authorizing with this order source */
+    AuthProcess: AuthSpecification;
     /** @description A list of branded order sources associated with this integration */
     FulfillmentProviders: FulfillmentProviderDefinition[];
 };
@@ -44,3 +46,135 @@ export declare type FulfillmentProviderDefinition = {
         IconUrl: string;
     };
 };
+/** @description Used to specify information about an integrations authentication */
+export declare class AuthSpecification {
+    /** @description Identify the type of Auth being used by the integration */
+    Identifier: AuthIdentifier;
+    /** @description Added to allow oauth 1.0 to work. */
+    access_token?: AccessToken;
+    /** @description Authorization: the beginning of an OAuth2.0 flow that ensures the user is logged
+     * in and approves access to the Resource. */
+    authorization?: AuthorizationConfiguration;
+    /** @description Request Token: server-server code for token exchange */
+    request_token?: RequestTokenConfiguration;
+    /** @description Refresh Token: server-server refresh token exchange for access token
+     * **NOTE: sometimes a new RT is also created** */
+    refresh_token?: RefreshTokenConfiguration;
+    /** @description Advanced configurations used for oauth 1.0 */
+    advanced_configuration?: Parameter[];
+    /** @description Connections is an optional feature that an integration may provide. A common use
+     * of connections is to provide the ability to connect to a sandbox or production endpoint.
+     * Connection name values may be accessed in a flow e.g in the request_token section, the url is
+     * dynamic.
+     *
+     *  "url_template": "{connection_name:$.url}/access/token/request", */
+    connections?: ConnectionNamesConfiguration;
+}
+export declare class AuthIdentifier {
+    AuthenticationType: AuthenticationType;
+    Version?: string;
+    IsSandbox?: boolean;
+}
+export declare enum AuthenticationType {
+    OAuth = "oauth",
+    Basic = "basic",
+    ApiKey = "apikey"
+}
+export declare class AccessToken {
+    /** @description OAuth1 only. The url to obtain the temporary Access (aka Request) Token to start a flow **/
+    url_template: string;
+}
+export declare class AuthorizationConfiguration {
+    /** @description The url to obtain the access token using the authorization code on the backend
+     * @example "http://{auth_state:store_name}.store.com/admin/oauth/authorize", "http://store.com/oauth/authorize" */
+    url_template: string;
+    /** @description A list of query parameters that will be attached to the url */
+    query_parameters?: Parameter[];
+    /** @description Method to use when making the server-server code for token request @example "GET", "POST" */
+    method?: string;
+    /** @description List of parameters that are sent to the integration during the server-server
+     * authorization request. These are built using the content type specified in the headers array. */
+    body?: Parameter[];
+    /** @description List of headers that are sent to the integration when authorizing a token */
+    headers?: Parameter[];
+    /** @description A nonce query parameter included on the accept request, then returned and validated on the redirect request */
+    nonce?: NonceConfiguration;
+}
+export declare class Parameter {
+    /** @description The name of the parameter */
+    name: string;
+    /** @description The value associated with the parameter */
+    value: string;
+}
+export declare class NonceConfiguration {
+    name: string;
+}
+export declare class RequestTokenConfiguration {
+    /** @description The url to obtain the access token using the authorization code on the backend @example "http://{auth_state:store_name}.store.com/admin/oauth/request", "http://store.com/oauth/request" */
+    url_template: string;
+    /** @description A list of query parameters that will be attached to the url */
+    query_parameters?: Parameter[];
+    /** @description Method to use when making the server-server code for token request @example "GET", "POST" */
+    method?: string;
+    /** @description List of parameters that are sent to the integration when exchanging the code for the token. These are built using ContentType */
+    body?: Parameter[];
+    /** @description List of headers that are sent to the integration when requesting a token */
+    headers?: Parameter[];
+    /** @description Response payload parsing */
+    response?: ResponseTransformationConfiguration;
+}
+export declare class ResponseTransformationConfiguration {
+    /** @description JSONPath to the JSON element for access_token. */
+    access_token: string;
+    /** @description JSONPath to the JSON element for token_type */
+    token_type: string;
+    /** @description JSONPath to the JSON element for refresh_token */
+    refresh_token?: string;
+    /** @description JSONPath to the JSON element for expires_in. Mutually exclusive with expires_at */
+    expires_in?: string;
+    /** @description Configuration for parsing a date-time, when the integration is lacking expires_in.
+     * Mutually exclusive with expires_in.
+     */
+    expires_at?: DateTimeConfiguration;
+    /** @description Optional collection of properties to include in the connection_context sent back with the auth flow result.
+     *  Property value may be JSONPath or a string literal.
+     *  E.g.
+     *  "connection_context": {
+     *    "store_id": "$.data.store_id"
+     *  }
+     */
+    connection_context?: MapOfStrings;
+}
+export declare class DateTimeConfiguration {
+    /** @description JSONPath to the JSON element containing the date-time */
+    path: string;
+    /** @description DateTime format string compliant with
+     * https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings */
+    date_time_format: string;
+}
+export declare type MapOfStrings = {
+    [key: string]: string;
+};
+export declare class RefreshTokenConfiguration {
+    /** @description The url to refresh the access token using the authorization code on the backend @example "http://{auth_state:store_name}.store.com/admin/oauth/refresh", "http://store.com/oauth/refresh" */
+    url_template: string;
+    /** @description A list of query parameters that will be attached to the url */
+    query_parameters?: Parameter[];
+    /** @description Method to use when making the server-server code for token request @example "GET", "POST" */
+    method?: string;
+    /** @description List of parameters that are sent to the integration during the server-server refresh token request. These are built using the content type specified in the headers array. */
+    body?: Parameter[];
+    /** @description List of headers that are sent to the integration when refreshing a token */
+    headers?: Parameter[];
+    /** @description Response payload parsing */
+    response?: ResponseTransformationConfiguration;
+}
+export declare class ConnectionNamesConfiguration {
+    /** @description A unique list of connection names that the integration supports. */
+    connection_names: MapOfObjects;
+    /** @description The connection name that will be used when none is selected. */
+    default_connection_name: string;
+}
+export declare type MapOfObjects = {
+    [key: string]: any;
+};

package/lib/app/fulfillment-provider-app-metadata.js

@@ -1,3 +1,44 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionNamesConfiguration = exports.RefreshTokenConfiguration = exports.DateTimeConfiguration = exports.ResponseTransformationConfiguration = exports.RequestTokenConfiguration = exports.NonceConfiguration = exports.Parameter = exports.AuthorizationConfiguration = exports.AccessToken = exports.AuthenticationType = exports.AuthIdentifier = exports.AuthSpecification = void 0;
+/** @description Used to specify information about an integrations authentication */
+class AuthSpecification {
+}
+exports.AuthSpecification = AuthSpecification;
+class AuthIdentifier {
+}
+exports.AuthIdentifier = AuthIdentifier;
+var AuthenticationType;
+(function (AuthenticationType) {
+    AuthenticationType["OAuth"] = "oauth";
+    AuthenticationType["Basic"] = "basic";
+    AuthenticationType["ApiKey"] = "apikey";
+})(AuthenticationType = exports.AuthenticationType || (exports.AuthenticationType = {}));
+class AccessToken {
+}
+exports.AccessToken = AccessToken;
+class AuthorizationConfiguration {
+}
+exports.AuthorizationConfiguration = AuthorizationConfiguration;
+class Parameter {
+}
+exports.Parameter = Parameter;
+class NonceConfiguration {
+}
+exports.NonceConfiguration = NonceConfiguration;
+class RequestTokenConfiguration {
+}
+exports.RequestTokenConfiguration = RequestTokenConfiguration;
+class ResponseTransformationConfiguration {
+}
+exports.ResponseTransformationConfiguration = ResponseTransformationConfiguration;
+class DateTimeConfiguration {
+}
+exports.DateTimeConfiguration = DateTimeConfiguration;
+class RefreshTokenConfiguration {
+}
+exports.RefreshTokenConfiguration = RefreshTokenConfiguration;
+class ConnectionNamesConfiguration {
+}
+exports.ConnectionNamesConfiguration = ConnectionNamesConfiguration;
 //# sourceMappingURL=fulfillment-provider-app-metadata.js.map

package/lib/app/fulfillment-provider-app-metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-provider-app-metadata.js","sourceRoot":"","sources":["../../src/app/fulfillment-provider-app-metadata.ts"],"names":[],"mappings":""}
+{"version":3,"file":"fulfillment-provider-app-metadata.js","sourceRoot":"","sources":["../../src/app/fulfillment-provider-app-metadata.ts"],"names":[],"mappings":";;;AAmDA,oFAAoF;AACpF,MAAa,iBAAiB;CAsB7B;AAtBD,8CAsBC;AAED,MAAa,cAAc;CAI1B;AAJD,wCAIC;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,qCAAe,CAAA;IACf,qCAAe,CAAA;IACf,uCAAiB,CAAA;AACnB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,MAAa,WAAW;CAGvB;AAHD,kCAGC;AAED,MAAa,0BAA0B;CAetC;AAfD,gEAeC;AAED,MAAa,SAAS;CAKrB;AALD,8BAKC;AAED,MAAa,kBAAkB;CAE9B;AAFD,gDAEC;AAED,MAAa,yBAAyB;CAarC;AAbD,8DAaC;AAED,MAAa,mCAAmC;CAqB/C;AArBD,kFAqBC;AAED,MAAa,qBAAqB;CAMjC;AAND,sDAMC;AAMD,MAAa,yBAAyB;CAarC;AAbD,8DAaC;AAED,MAAa,4BAA4B;CAKxC;AALD,oEAKC"}

package/lib/app/fulfillment-provider-app.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FulfillmentProviderApp = void 0;
-const path_1 = require("path");
-const fs_1 = require("fs");
+const spec_1 = require("../spec");
 const internal_1 = require("./internal");
 const handleRequest = (implementation) => {
     return (request) => {
@@ -11,18 +10,13 @@ const handleRequest = (implementation) => {
 };
 class FulfillmentProviderApp {
     constructor(definition) {
-        this.redoc = fs_1.readFileSync(path_1.resolve(__dirname, '../../spec.yaml')).toString();
+        this.redoc = JSON.stringify(spec_1.OpenApiSpecification);
         this.routes = [
             {
                 method: internal_1.Method.POST,
                 path: '/connect',
                 handler: handleRequest(definition.connect),
             },
-            {
-                method: internal_1.Method.POST,
-                path: '/reconnect',
-                handler: handleRequest(definition.reconnect),
-            },
             {
                 method: internal_1.Method.POST,
                 path: '/fulfillment/delegation',
@@ -38,11 +32,6 @@ class FulfillmentProviderApp {
                 path: '/fulfillment/cancellation',
                 handler: handleRequest(definition.requestCancellation),
             },
-            {
-                method: internal_1.Method.POST,
-                path: '/inventory',
-                handler: handleRequest(definition.getInventory),
-            },
             {
                 method: internal_1.Method.POST,
                 path: '/rates',

package/lib/app/fulfillment-provider-app.js.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-provider-app.js","sourceRoot":"","sources":["../../src/app/fulfillment-provider-app.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,2BAAkC;AAElC,yCAMoB;AAEpB,MAAM,aAAa,GAAG,CAAC,cAAwB,EAAO,EAAE;IACtD,OAAO,CAAC,OAAY,EAAE,EAAE;QACtB,OAAO,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAa,sBAAsB;IAKjC,YAAY,UAA4C;QAFxD,UAAK,GAAG,iBAAY,CAAC,cAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAGrE,IAAI,CAAC,MAAM,GAAG;YACZ;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC;aAC3C;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC;aAC7C;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,yBAAyB;gBAC/B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,mBAAmB,CAAC;aACvD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,qBAAqB;gBAC3B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC;aAC7C;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,2BAA2B;gBACjC,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,mBAAmB,CAAC;aACvD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,YAAY,CAAC;aAChD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC;aAC5C;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,qBAAqB;gBAC3B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,gBAAgB,CAAC;aACpD;SACF,CAAC;QAEF,IAAI,CAAC,IAAI,GAAG,IAAI,8CAAmC,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACxF,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACrD,OAAO;gBACL,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;gBAC7B,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;aAC9B,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA7DD,wDA6DC"}
+{"version":3,"file":"fulfillment-provider-app.js","sourceRoot":"","sources":["../../src/app/fulfillment-provider-app.ts"],"names":[],"mappings":";;;AAGA,kCAA+C;AAC/C,yCAMoB;AAEpB,MAAM,aAAa,GAAG,CAAC,cAAwB,EAAO,EAAE;IACtD,OAAO,CAAC,OAAY,EAAE,EAAE;QACtB,OAAO,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAa,sBAAsB;IAKjC,YAAY,UAA4C;QAFxD,UAAK,GAAG,IAAI,CAAC,SAAS,CAAC,2BAAoB,CAAC,CAAC;QAG3C,IAAI,CAAC,MAAM,GAAG;YACZ;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC;aAC3C;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,yBAAyB;gBAC/B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,mBAAmB,CAAC;aACvD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,qBAAqB;gBAC3B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC;aAC7C;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,2BAA2B;gBACjC,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,mBAAmB,CAAC;aACvD;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC;aAC5C;YACD;gBACE,MAAM,EAAE,iBAAM,CAAC,IAAI;gBACnB,IAAI,EAAE,qBAAqB;gBAC3B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,gBAAgB,CAAC;aACpD;SACF,CAAC;QAEF,IAAI,CAAC,IAAI,GAAG,IAAI,8CAAmC,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACxF,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACrD,OAAO;gBACL,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;gBAC7B,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;aAC9B,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAnDD,wDAmDC"}

package/lib/app/internal/metadata.d.ts

@@ -1,82 +1,12 @@
 import { Route } from '.';
 import { FulfillmentProviderAppMetadata, Connector } from '..';
-export declare class FulfillmentProviderAppSpecification {
-    /**
-     *
-     */
+import { AuthSpecification, FulfillmentProviderDefinition } from '../fulfillment-provider-app-metadata';
+export declare class FulfillmentProviderAppSpecification implements FulfillmentProviderAppMetadata {
     constructor(metadata: FulfillmentProviderAppMetadata, routes: Route[]);
-    /** @description Fulfillment provider identifying information */
-    Id: {
-        /** @description The unique id for this integration */
-        Id: string;
-        /** @description The name of this integration */
-        Name: string;
-        /** @description The alternate name for this integration */
-        Alias: string;
-    };
-    /** @description Internal state for this fulfillment provider */
-    Status: string;
-    /** @description A list of branded order sources associated with this integration */
-    FulfillmentProviders: FulfillmentProviderSpecification[];
+    AuthProcess: AuthSpecification;
+    Id: string;
+    Name: string;
+    FulfillmentProviders: FulfillmentProviderDefinition[];
     /** @description Internal information about the connector */
     Connector: Connector;
 }
-export declare type FulfillmentProviderSpecification = {
-    /** @description This is a unique GUID identifier for this order source */
-    Id: string;
-    /** @description The branded name for this fulfillment provider @example "FBA", "Shipwore" */
-    Name: string;
-    /** @description The long text description for this fulfillment provider */
-    Description: string;
-    /** @description Internal searchable tags to find this fulfillment provider */
-    Tags: string;
-    /** @description Internal human friendly and uniquely identifying code for exposing in an api */
-    ApiCode: string;
-    /** @description Internal flag for if this fulfillment provider supports inventory stocking details */
-    InventoryLevels: boolean;
-    /** @description Internal flag for if fulfillment provider is available for all customers */
-    IsLive: boolean;
-    /** @description Internal flag for if this fulfillment provider is enabled */
-    Active: boolean;
-    /** @description Internal order which this fulfillment provider is shown */
-    SortOrder: number;
-    /** @description The list of available fulfillment services */
-    FulfillmentServices: FulfillmentServiceSpecification[];
-    /** @description Specifies connection forms */
-    AccountModals: {
-        /** @description Defines fields for registration */
-        RegistrationFormSchema: {
-            JsonSchema: object;
-            UiSchema: object;
-        };
-        /** @description Defines fields for changes to the connection */
-        SettingsFormSchema: {
-            JsonSchema: object;
-            UiSchema: object;
-        };
-    };
-    /** @description Images that will be used for this branded order source */
-    Images: {
-        /** @description The full path to the logo used in modals and other areas of our platform for this order source. Use join(__dirname, '../assets/logo.svg') @example "/dev/integration/assets/ordersource1/logo.svg" */
-        LogoUrl: string;
-        /** @description The full path to the icon used for this order source. Use join(__dirname, '../assets/logo.svg') @example "/dev/integration/assets/ordersource1/icon.svg" */
-        IconUrl: string;
-    };
-};
-export declare type FulfillmentServiceSpecification = {
-    /** @description Name of the shipping service */
-    Name: string;
-    /** @description Shortened name of the shipping service */
-    Abbreviation: string;
-    /** @description Internal code for identifying this service */
-    Code: string;
-    /** @description Internal sorting order for this service */
-    SortOrder: number;
-    /** @description Internal flag for if this service is selectable */
-    Active: boolean;
-    /** @description Internal human friendly identifying code for exposing in an api */
-    ApiCode: string;
-};
-export declare function snakeCase(text: string, options?: {
-    delimiter: string;
-}): string;

package/lib/app/internal/metadata.js

@@ -1,108 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.snakeCase = exports.FulfillmentProviderAppSpecification = void 0;
+exports.FulfillmentProviderAppSpecification = void 0;
 class FulfillmentProviderAppSpecification {
-    /**
-     *
-     */
     constructor(metadata, routes) {
-        /** @description Internal state for this fulfillment provider */
-        this.Status = 'Active';
-        this.Id = {
-            Id: metadata.Id,
-            Name: metadata.Name,
-            Alias: snakeCase(metadata.Name, { delimiter: '-' }).toLowerCase(),
-        };
-        let sortOrder = 0;
-        this.FulfillmentProviders = metadata.FulfillmentProviders.map((p) => ({
-            Id: p.Id,
-            Name: p.Name,
-            Description: p.Description,
-            Tags: `|${formattedTags(['Fulfillment', ...extractTags(p.Name)])}|`,
-            ApiCode: snakeCase(p.Name).toLowerCase(),
-            InventoryLevels: true,
-            IsLive: true,
-            Active: true,
-            SortOrder: sortOrder++,
-            AccountModals: {
-                RegistrationFormSchema: {
-                    JsonSchema: p.AccountModals.RegistrationFormSchema.JsonSchema,
-                    UiSchema: p.AccountModals.RegistrationFormSchema.UiSchema,
-                },
-                SettingsFormSchema: {
-                    JsonSchema: p.AccountModals.SettingsFormSchema.JsonSchema,
-                    UiSchema: p.AccountModals.SettingsFormSchema.UiSchema,
-                },
-            },
-            Images: {
-                IconUrl: p.Images.IconUrl,
-                LogoUrl: p.Images.LogoUrl,
-            },
-            FulfillmentServices: p.FulfillmentServices.map((s) => ({
-                Name: s.Name,
-                Abbreviation: s.Abbreviation || s.Name,
-                Active: true,
-                Code: s.Name,
-                SortOrder: sortOrder++,
-                ApiCode: snakeCase(s.Name).toLowerCase(),
-            })),
-        }));
+        this.Id = metadata.Id;
+        this.Name = metadata.Name;
+        this.FulfillmentProviders = metadata.FulfillmentProviders;
+        this.AuthProcess = metadata.AuthProcess;
+        this.AuthProcess.Identifier.Version = '2.0';
         this.Connector = {
             DiagnosticRoutes: {
                 Liveness: '/diagnostics/liveness',
                 Readiness: '/diagnostics/readiness',
                 Version: '/diagnostics/version',
             },
-            ApiVersion: '1.0.0',
+            ApiVersion: '2.0.0',
             Functions: routes.map(mapRoutes),
         };
     }
 }
 exports.FulfillmentProviderAppSpecification = FulfillmentProviderAppSpecification;
-function extractTags(name) {
-    return name.split(' ');
-}
-function formattedTags(parts) {
-    return parts.join('|');
-}
-function mapRoutes(route) {
+const mapRoutes = (route) => {
     return {
-        Name: snakeCase(route.path.replace('/', ''), {
-            delimiter: '-',
-        }).toLowerCase(),
+        Name: route.path.replace('/', ''),
         IsSandboxed: false,
     };
-}
-function snakeCase(text, options = { delimiter: '_' }) {
-    let snaked = '';
-    let wasLower = false;
-    let wasNumber = false;
-    for (let i = 0; i < text.length; i++) {
-        const l = text[i];
-        const isLower = l >= 'a' && l <= 'z';
-        const isNumber = l >= '0' && l <= '9';
-        const isUpper = l >= 'A' && l <= 'Z';
-        const isHyphen = l === '-' || l === '_' || l === ' ';
-        if (!isLower && !isNumber && !isUpper && !isHyphen) {
-            continue;
-        }
-        if (isHyphen) {
-            snaked += options.delimiter;
-            wasLower = false;
-            wasNumber = false;
-            continue;
-        }
-        if (isUpper && wasLower) {
-            snaked += options.delimiter;
-        }
-        if ((isUpper || isLower) && wasNumber) {
-            snaked += options.delimiter;
-        }
-        wasNumber = isNumber;
-        wasLower = isLower;
-        snaked += text[i];
-    }
-    return snaked;
-}
-exports.snakeCase = snakeCase;
+};
 //# sourceMappingURL=metadata.js.map

package/lib/app/internal/metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/app/internal/metadata.ts"],"names":[],"mappings":";;;AAGA,MAAa,mCAAmC;IAC9C;;OAEG;IACH,YAAY,QAAwC,EAAE,MAAe;QAgErE,gEAAgE;QAChE,WAAM,GAAW,QAAQ,CAAC;QAhExB,IAAI,CAAC,EAAE,GAAG;YACR,EAAE,EAAE,QAAQ,CAAC,EAAE;YACf,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE;SAClE,CAAC;QAEF,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,CAAC,oBAAoB,GAAG,QAAQ,CAAC,oBAAoB,CAAC,GAAG,CAC3D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACN,EAAE,EAAE,CAAC,CAAC,EAAE;YACR,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,WAAW,EAAE,CAAC,CAAC,WAAW;YAC1B,IAAI,EAAE,IAAI,aAAa,CAAC,CAAC,aAAa,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG;YACnE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE;YACxC,eAAe,EAAE,IAAI;YACrB,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE,SAAS,EAAE;YACtB,aAAa,EAAE;gBACb,sBAAsB,EAAE;oBACtB,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,sBAAsB,CAAC,UAAU;oBAC7D,QAAQ,EAAE,CAAC,CAAC,aAAa,CAAC,sBAAsB,CAAC,QAAQ;iBAC1D;gBACD,kBAAkB,EAAE;oBAClB,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAAC,UAAU;oBACzD,QAAQ,EAAE,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAAC,QAAQ;iBACtD;aACF;YACD,MAAM,EAAE;gBACN,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO;gBACzB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO;aAC1B;YACD,mBAAmB,EAAE,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAkC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACtF,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,YAAY,EAAE,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,IAAI;gBACtC,MAAM,EAAE,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,SAAS,EAAE,SAAS,EAAE;gBACtB,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE;aACzC,CAAC,CAAC;SACJ,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,SAAS,GAAG;YACf,gBAAgB,EAAE;gBAChB,QAAQ,EAAE,uBAAuB;gBACjC,SAAS,EAAE,wBAAwB;gBACnC,OAAO,EAAE,sBAAsB;aAChC;YACD,UAAU,EAAE,OAAO;YACnB,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC;SACjC,CAAC;IACJ,CAAC;CAiBF;AA1ED,kFA0EC;AA4DD,SAAS,WAAW,CAAC,IAAY;IAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,aAAa,CAAC,KAAe;IACpC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,SAAS,CAAC,KAAY;IAC7B,OAAO;QACL,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE;YAC3C,SAAS,EAAE,GAAG;SACf,CAAC,CAAC,WAAW,EAAE;QAChB,WAAW,EAAE,KAAK;KACnB,CAAC;AACJ,CAAC;AAED,SAAgB,SAAS,CAAC,IAAY,EAAE,UAAiC,EAAE,SAAS,EAAE,GAAG,EAAE;IACzF,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACpC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,MAAM,OAAO,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;QACrC,MAAM,QAAQ,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;QACtC,MAAM,OAAO,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;QACrC,MAAM,QAAQ,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC;QAErD,IAAI,CAAC,OAAO,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE;YAClD,SAAS;SACV;QAED,IAAI,QAAQ,EAAE;YACZ,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC;YAC5B,QAAQ,GAAG,KAAK,CAAC;YACjB,SAAS,GAAG,KAAK,CAAC;YAClB,SAAS;SACV;QAED,IAAI,OAAO,IAAI,QAAQ,EAAE;YACvB,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC;SAC7B;QAED,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,SAAS,EAAE;YACrC,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC;SAC7B;QAED,SAAS,GAAG,QAAQ,CAAC;QACrB,QAAQ,GAAG,OAAO,CAAC;QAEnB,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;KACnB;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AArCD,8BAqCC"}
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/app/internal/metadata.ts"],"names":[],"mappings":";;;AAOA,MAAa,mCAAmC;IAC9C,YAAY,QAAwC,EAAE,MAAe;QACnE,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,oBAAoB,GAAG,QAAQ,CAAC,oBAAoB,CAAC;QAC1D,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC;QAE5C,IAAI,CAAC,SAAS,GAAG;YACf,gBAAgB,EAAE;gBAChB,QAAQ,EAAE,uBAAuB;gBACjC,SAAS,EAAE,wBAAwB;gBACnC,OAAO,EAAE,sBAAsB;aAChC;YACD,UAAU,EAAE,OAAO;YACnB,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC;SACjC,CAAC;IACJ,CAAC;CAQF;AAzBD,kFAyBC;AAED,MAAM,SAAS,GAAG,CAAC,KAAY,EAAyB,EAAE;IACxD,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;QACjC,WAAW,EAAE,KAAK;KACnB,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-fulfillment-provider-api",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "OpenAPI specification and TypeScript definitions for the Connect Fulfillment Provider API",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",