Gathering detailed insights and metrics for @serverless/platform-client
Gathering detailed insights and metrics for @serverless/platform-client
Installations
npm install @serverless/platform-clientDeveloper Guide
BETA
Typescript
No
Module System
CommonJS, UMD
Min. Node Version
>=10.0
Node Version
14.21.3
NPM Version
6.14.18
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
3
Package Meta Information
Latest Version
4.5.1
Package Id
@serverless/platform-client@4.5.1
Unpacked Size
840.44 kB
Size
201.00 kB
File Count
24
NPM Version
6.14.18
Node Version
14.21.3
Published on
Nov 16, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Serverless Platform SDK
This Serverless Platform SDK makes it easy to interact with the Serverless Platform and perform operations on it. Please note that there is an existing @serverless/platform-sdk npm module for interacting with the Serverless Inc. SaaS original platform services. This SDK is for the new services, which are multi-cloud, self-hostable and focued on Components. At some point, we will try to merge these SDKs.
The SDK is light-weight, so that it can be used in the following: CLIs, Dashboards, Back-End Services, FaaS Layers. Please DO NOT add any big Node.js dependencies to this SDK.
This SDK should guide the interface design between Services and Clients. All Clients and Services MUST use the SDK and should never hardcode API endpoints or FaaS resources identifiers.
Quick-Start
If you are working within a Node.js environment, install the Serverless Platform Client SDK via NPM:
npm i @serverless/platform-client
If you are working within a web/browser environment, use the CDN hosted Serverless Platform Client SDK:
This is minified, tree-shaked, browserified. The CDN fetches it directly from NPM, so just reference any npm version, like below.
This CDN service has several locations in China, so it works well there.
// In index.html <head></head>
<!-- Load the Serverless Platform (Components) SDK -->
<script src="https://cdn.jsdelivr.net/npm/@serverless/platform-client@0.17.2" async></script>
You can also pin to the latest version, but this could break at any time:
// In index.html <head></head>
<!-- Load the Serverless Platform (Components) SDK -->
<script src="https://cdn.jsdelivr.net/npm/@serverless/platform-client" async></script>
If you are working with the dev environment of the Serverless Platform, set the following environment variable, or configure the client programmatically, as detailed below.
export SERVERLESS_PLATFORM_STAGE=dev
Here is how you require, instantiate the Client and use it:
1const { ServerlessSDK } = require("@serverless/platform-client"); 2 3sdk = new ServerlessSDK({ 4 platformStage: "dev", // Optional. Defaults to 'prod' 5 accessKey: "JA98JAJFASLFJSALFJASLFJ", // Optional, but recommended. Platform Access Key needed to identify all requests. 6}); 7 8const instances = await sdk.listInstances("my-org");
Classes
- ServerlessSDK
The Serverless Platform SDK Class
Typedefs
- onEvent :
function onEventcallback- onDisconnect :
function onDisconnectcallback
ServerlessSDK
The Serverless Platform SDK Class
Kind: global class
- ServerlessSDK
- new ServerlessSDK()
- .session :
object- .refreshToken(refreshToken) ⇒
Promise.<object>
- .refreshToken(refreshToken) ⇒
- .events :
object- .publish(event) ⇒
Promise.<null> - .get(uid) ⇒
Promise.<Object> - .list([options]) ⇒
Promise.<Object> .send(event) ⇒Promise.<null>
- .publish(event) ⇒
- .frameworkDeployments :
object- .create([params]) ⇒
Promise.<object> - .list([params]) ⇒
Promise.<array>
- .create([params]) ⇒
- .webhooks :
object- .register(url, [options]) ⇒
Promise.<object> - .list([options]) ⇒
Promise.<object> - .get(uid) ⇒
Promise.<object> - .update(uid) ⇒
Promise.<object> - .delete(uid) ⇒
Promise.<object>
- .register(url, [options]) ⇒
- .accessKeys :
object- .create(orgName, userName, accessKeyName) ⇒
Promise.<object> - .list(orgName) ⇒
Promise.<object> - .remove(orgName, uid) ⇒
Promise.<object> - .get() ⇒
Promise.<(object|null)>
- .create(orgName, userName, accessKeyName) ⇒
- .connections :
object- .create(orgUid, providerUid, accountAlias) ⇒
Promise.<object> - .list(orgUid) ⇒
Promise.<object> - .get(orgUid, connectionUid) ⇒
Promise.<object> - .getByOrgAndAccountAlias(orgUid, accountAlias) ⇒
Promise.<object> - .update(orgUid, connectionUid, providerUid, accountAlias, status) ⇒
Promise.<object> - .remove(orgUid, connectionUid) ⇒
Promise.<object> - .syncAll(orgUid) ⇒
Promise.<object> - .unsync(orgUid, connectionUid) ⇒
Promise.<object>
- .create(orgUid, providerUid, accountAlias) ⇒
- .desktop :
object- .createSavedQuery(orgUid, appUid, serviceName, savedQuery) ⇒
Promise.<object> - .getSavedQuery(orgUid, appUid, serviceName, savedQueryUid) ⇒
Promise.<object> - .updateSavedQuery(orgUid, appUid, serviceName, savedQueryUid, savedQuery) ⇒
Promise.<object> - .deleteSavedQuery(orgUid, appUid, serviceName, savedQueryUid) ⇒
Promise.<object> - .listSavedQueries(orgUid, appUid, serviceName) ⇒
Promise.<object>
- .createSavedQuery(orgUid, appUid, serviceName, savedQuery) ⇒
- .logDestinations :
object- .getOrCreate([params]) ⇒
Promise.<object> - .remove([params]) ⇒
Promise.<object>
- .getOrCreate([params]) ⇒
- .deploymentProfiles :
object- .get([params]) ⇒
Promise.<Object> - .create([params]) ⇒
Promise.<Object> - .list([params]) ⇒
Promise.<array> - .setDefault([params]) ⇒
Promise.<Object>
- .get([params]) ⇒
- .organizations :
object- .get([params]) ⇒
object - .list([params]) ⇒
array - .create([params]) ⇒
object - .validate([params]) ⇒
array
- .get([params]) ⇒
- .apps :
object- .create([params]) ⇒
object - .get([params])
- .update([params]) ⇒
object - .remove([params])
- .list([params])
- .create([params]) ⇒
- .metadata :
object- .get() ⇒
Promise.<Object>
- .get() ⇒
- .config() ⇒
null - .getDomain(serviceName) ⇒
string - .getUser() ⇒
object - .getUserMeta() ⇒
object - .saveUserMeta(userMeta) ⇒
object .validateUserAndOrgName(userAndOrgName) ⇒array.createUserAndOrg(userAndOrgName) ⇒object.createOrg(userAndOrgName) ⇒object.getOrgByName(orgName) ⇒object.listOrgs(username) ⇒object.createApp(orgName) ⇒object.updateApp(orgName) ⇒object.deleteApp(orgName, appName).listApps(orgName)- .createInitToken(orgName)
- .getInitToken(initTokenUid)
- .createProvider(orgUid, data)
- .updateProvider(orgUid, providerUid, data)
- .setDefaultProvider(orgUid, providerUid)
- .unsetDefaultProvider(orgUid, providerUid)
- .deleteProvider(orgUid, providerUid)
- .createProviderLink(orgUid, linkType, linkUid, providerUid)
- .deleteProviderLink(orgUid, linkType, linkUid, providerUid)
- .getProviders(orgUid)
- .getProvider(orgUid, providerUid)
- .getProvidersByOrgServiceInstance(orgUid, serviceUid, instanceUid)
- .getProvidersByLink(orgUid, linkType, linkUid)
- .getAllowedProviders()
- .createParam(orgUid, linkType, linkUid, data)
- .deleteParam(orgUid, linkType, linkUid, paramUid)
- .updateParam(orgUid, linkType, linkUid, paramUid, data)
- .getParams(orgUid, linkType, linkUid)
- .getParamsByOrgServiceInstance(orgUid, serviceUid, instanceUid)
- .getParamsAndProvidersByOrgServiceInstance(orgUid, serviceUid, instanceUid)
- .connect([options]) ⇒
null - .disconnect() ⇒
null - .isConnected() ⇒
boolean - .unpublishFromRegistry(registryPackage)
- .publishToRegistry(registryPackage) ⇒
object - .getFromRegistry(name, version) ⇒
object - .generateInstanceId(orgUid, stageName, appUid, instanceName) ⇒
object - .validateInstance(instanceToValidate) ⇒
object - .createInstance(orgName, stageName, appName, instanceName, instanceStatus) ⇒
object - .saveInstance(instanceRecord)
- .getInstance(orgName, stageName, appName, instanceName)
- .listInstances(orgName, orgUid)
- .run(action, instanceData, options)
- .runFinish(method, instanceData, meta)
- .deploy()
- .remove()
- .startInterceptingLogs(eventType, context)
- .stopInterceptingLogs()
new ServerlessSDK()
Creates an instance of the SDK. Accepts a configuration object and calls the config() method. See the config() method for more information on allowed configuration.
| Param | Type | Description |
|---|---|---|
| [config.accessKey] | string | Can either be a Serverless Platform Access Key or an ID Token. |
| [config.platformStage] | string | The Serverless Platform Stage you wish to interact with. This can also be set by the environment variable SERVERLESS_PLATFORM_STAGE= |
| [context.orgName] | string | The name of the Serverless Platform Organization you wish to interact with. If set, this value is used upon creating a Websockets connection, and auto-added to every Event you publish. |
| [context.orgUid] | string | The ID of the Serverless Platform Organization you wish to interact with. If set, this value is used upon creating a Websockets connection, and auto-added to every Event you publish. |
| [context.stageName] | string | The Serverless Platform Organization Stage you wish to interact with. If set, this value is auto-added to every Event you publish. |
| [context.appName] | string | The Serverless Platform Application you wish to interact with. If set, this value is auto-added to every Event you publish. |
| [context.instanceName] | string | The Serverless Platform Instance you wish to interact with. If set, this value is auto-added to every Event you publish. |
| [context.componentName] | string | The Serverless Platform Component you wish to interact with. If set, this value is auto-added to every Event you publish. |
| [context.componentVersion] | string | The Serverless Platform Component version you wish to interact with. If set, this value is auto-added to every Event you publish. |
Example
1const { ServerlessSDK } = require("@serverless/platform-client"); 2 3const sdk = new ServerlessSDK({ 4 accessKey: "123456789", 5 context: { 6 orgName: "my-org", 7 orgUid: "1234", 8 stageName: "prod", 9 appName: "my-app", 10 instanceName: "my-instance", 11 }, 12});
serverlessSDK.session : object
Methods to create, update, delete User Sessions on the Serverless Platform
Kind: instance namespace of ServerlessSDK
session.refreshToken(refreshToken) ⇒ Promise.<object>
Uses a Refresh Token to generate a new ID Token for a User within a specific Serverless Organization.
Kind: static method of session
| Param | Type | Description |
|---|---|---|
| refreshToken | string | The refresh token used to create a new ID Token. |
Example
1const tokenData = await sdk.session.refreshToken(refreshToken);
serverlessSDK.events : object
Publish and retrieve Serverless Platform Events
Kind: instance namespace of ServerlessSDK
- .events :
object- .publish(event) ⇒
Promise.<null> - .get(uid) ⇒
Promise.<Object> - .list([options]) ⇒
Promise.<Object> .send(event) ⇒Promise.<null>
- .publish(event) ⇒
events.publish(event) ⇒ Promise.<null>
Publishes Serverless Platform Event(s) via HTTP API. The use-case for this is synchronous publishing, where you do not want to open a websockets connection.
Kind: static method of events
Returns: Promise.<null> - A successful publish request will be ack'ed with a 200:OK HTTP status and empty response.
| Param | Type | Description |
|---|---|---|
| event | Object | Array.<Object> | An event object, or if publishing a batch of events, an array of event objects. |
| event.event | string | Event type. Serverless Platform system events are required to follow a <entity>[.<sub-entity>].<action> naming convention (e.g. user.created, org.membership.updated, etc). |
| event.data | Object | Event metadata. Serverless Platform system events are required to be formatted as described in the example below. |
Example (user event)
1sdk.config({ context: { orgUid: "3xVy2MWGFqpGYSlRMd" } }); 2await sdk.events.publish({ 3 event: "user.created", 4 data: { 5 id: "user-123", 6 username: "testuser", 7 }, 8});
Example (system event)
1await sdk.events.publish({ 2 event: "entity.updated", // follows a `<entity>[.<sub-entity>].<action>` naming convention 3 user_uid: "user-111", // user attributable for event action if applicable - optional 4 // either of the following properties are required to be set and if not, inherit from current sdk context 5 org_uid: "org-42", 6 org_name: "serverless", 7 // the following properties are optional and default to inheriting from current sdk context 8 app_name: "app-222", 9 instance_name: "instance-333", 10 stage_name: "us-east-1", 11 component_name: "component-444", 12 component_version: "1.2.3", 13 data: { 14 // event payload - required and must match the format below 15 object: { 16 // Serverless Platform object targeted by action 17 object: "name", 18 // ...properties 19 }, 20 previous_attributes: { 21 // only set on `*.updated` event types and contains modified property values as of before the update 22 //...properties 23 }, 24 }, 25});
events.get(uid) ⇒ Promise.<Object>
Retrieve a Serverless Platform Event.
Kind: static method of events
Returns: Promise.<Object> - An event object if a valid id was provided.
| Param | Type | Description |
|---|---|---|
| uid | string | UID of event to be fetched. |
Example
1const event = await sdk.events.get("evt_EsbM82sYTVscqYvcD4CKcLe1"); 2console.log(JSON.stringify(event, null, 2)); 3// outputs: 4// { 5// "uid": "evt_EsbM82sYTVscqYvcD4CKcLe1", 6// "event": "member.invite.sent", 7// "org_uid": "3xVy2MWGFqpGYSlRMd", 8// "user_uid": "ps4Vt2phVXsMyD0byW", 9// "object": "event", 10// "created": 1600686488878, 11// "data": { 12// "object": { 13// "org_uid": "3xVy2MWGFqpGYSlRMd", 14// "role": "collaborator", 15// "invited_by_user_uid": "ps4Vt2phVXsMyD0byW", 16// "created": "2020-09-21T11:08:08.603Z", 17// "recipient_email": "dev@serverless.com", 18// "org_name": "serverless", 19// "object": "invite" 20// } 21// } 22// }
events.list([options]) ⇒ Promise.<Object>
List all Serverless Platform events.
Kind: static method of events
Returns: Promise.<Object> - A dictionary with a data property that contains an array of up to limit events, starting after event starting_after. Each entry in the array is a separate event Object. If no more events are available, the resulting array will be empty.
| Param | Type | Description |
|---|---|---|
| [options] | Object | List options |
| options.org_uid | string | UID of the Serverless Platform Organization. Optional - defaults to inheriting from current SDK context. |
| options.org_name | string | Name of the Serverless Platform Organization. Optional - defaults to inheriting from current SDK context. |
| options.event | string | A string containing a specific event name, or all events by using '*' as a wildcard. |
| options.limit | number | A limit on the number of events to be returned. Limit can range between 1 and 100, and the default is 10. |
| options.created | number | A filter on the list based on the object created field. The value can be an integer Unix timestamp, or it can be a dictionary with the following options: - created.gt, created.gte, created.lt, created.lte returning results where the event created field is greater, greater than or equal to, lesser than, or lesser than or equal to respectively. |
| options.starting_after | string | A cursor for use in pagination. starting_after is an event ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with evt_foo, your subsequent call can include starting_after=evt_foo in order to fetch the next page of the list. |
Example
1const events = await sdk.events.list({ 2 event: "member.invite.accepted", 3 created: { 4 gte: 1600686488878, 5 }, 6 limit: 1, 7}); 8console.log(JSON.stringify(events, null, 2)); 9// outputs: 10// { 11// "object": "list", 12// "data": [ 13// { 14// "uid": "evt_DdUCdz2tsY7gZr1a9Z6Xw9BD", 15// "event": "member.invite.accepted", 16// "object": "event", 17// "created": 1600707548900, 18// "data": { 19// "object": { 20// "object": "invite", 21// "org_uid": "3xVy2MWGFqpGYSlRMd", 22// "role": "collaborator", 23// "invited_by_user_uid": "ps4Vt2phVXsMyD0byW", 24// "recipient_email": "dev@serverless.com", 25// "org_name": "serverless", 26// "created": "2020-09-21T11:08:08.603Z", 27// } 28// } 29// } 30// ] 31// }
events.send(event) ⇒ Promise.<null>
Promise.<null>Deprecated
Dispatches a Serverless Platform Event via Websockets. The use-case for this is asynchronous publishing, where you do not want to synchronous auth requests, where every message must be authorized first, adding latency.
Kind: static method of events
Returns: Promise.<null> - A successful publish request will be ack'ed with a 200: OK HTTP status and empty response.
See: publish
| Param | Type | Description |
|---|---|---|
| event | Object | Array.<Object> | An event object, or if publishing a batch of events, an array of event objects. |
| event.event | string | Event type. Serverless Platform system events are required to follow a <entity>[.<sub-entity>].<action> naming convention (e.g. user.created, org.membership.updated, etc). |
| event.data | Object | Event metadata. Serverless Platform system events are required to be formatted as described in the example below. |
serverlessSDK.frameworkDeployments : object
Manage Serverless Platform Deployments for Serverless Framework Traditional
Kind: instance namespace of ServerlessSDK
- .frameworkDeployments :
object- .create([params]) ⇒
Promise.<object> - .list([params]) ⇒
Promise.<array>
- .create([params]) ⇒
frameworkDeployments.create([params]) ⇒ Promise.<object>
Create a new Serverless Platform Deployment. Additionally, if Service with provided serviceName does not exist, it will be created automatically as well.
Kind: static method of frameworkDeployments
Returns: Promise.<object> - Saved deployment object.
| Param | Type | Description |
|---|---|---|
| [params] | Object | Create deployment params. |
| params.orgName | string | The name of the Serverless Platform Organization to create the Deployment in. |
| params.appName | string | The name of the Serverless Platform Application to create the Deployment in. |
| params.serviceName | string | The name of the Serverless Platform Service to create the Deployment in. |
| params.stageName | string | The name of the Serverless Service Stage to create the Deployment in. |
| params.regionName | string | The name of the AWS Region to create the Deployment in. |
| params.deploymentData | Object | Data associated with saved deployment |
frameworkDeployments.list([params]) ⇒ Promise.<array>
List Serverless Platform Deployments.
Kind: static method of frameworkDeployments
Returns: Promise.<array> - Array of Deployments.
| Param | Type | Description |
|---|---|---|
| [params] | Object | List deployment params. |
| params.orgName | string | The name of the Serverless Platform Organization to list the Deployments for. |
| params.appName | string | The name of the Serverless Platform Application to list the Deployment for. |
| params.serviceName | string | The name of the Serverless Platform Service to list the Deployment for. |
| params.stageName | string | The name of the Serverless Service Stage to list the Deployment for. |
| params.regionName | string | The name of the AWS Region to list the Deployment for. |
| params.cursor | string | The cursor from which Deployments should be listed. Used for pagination. |
serverlessSDK.webhooks : object
Register, modify and query Serverless Platform Event Webhooks
Kind: instance namespace of ServerlessSDK
- .webhooks :
object- .register(url, [options]) ⇒
Promise.<object> - .list([options]) ⇒
Promise.<object> - .get(uid) ⇒
Promise.<object> - .update(uid) ⇒
Promise.<object> - .delete(uid) ⇒
Promise.<object>
- .register(url, [options]) ⇒
webhooks.register(url, [options]) ⇒ Promise.<object>
Registers a webhook endpoint to receive Serverless Platform events.
Endpoint should be able to receieve JSON formatted events as a HTTP POST payload.
Furthermore, a 3 second timeout limit is enforced on event delivery with no additional retries performed.
The following HTTP headers are set on the POST request:
| Header | Value |
|---|---|
Content-type | application/json |
X-Serverless-Event | Event type |
X-Serverless-Delivery | Unique delivery ID |
User-Agent | Prefix of Serverless-Webhook/ |
Kind: static method of webhooks
Returns: Promise.<object> - Registered webhook endpoint.
| Param | Type | Description |
|---|---|---|
| url | string | HTTP webhook endpoint URL. |
| [options] | Object | Registration options. |
| options.description | string | An optional description of what the webhook is used for. |
| options.org_uid | string | UID of the Serverless Platform Organization. Optional - defaults to inheriting from current SDK context. If registering a Serverless Platform system webhook, use a special wildcard value of '*' to consume events generated from all orgs. |
| options.org_name | string | Name of the Serverless Platform Organization. Optional - defaults to inheriting from current SDK context. |
| options.filter | Object | Optionally, filter which events this endpoint should receive. |
| options.filter.enabled_events | Array.<string> | The list of events to enable for this endpoint. ["*"] indicates that all events are enabled. |
Example
1const webhook = await sdk.webhooks.register( 2 "https://postb.in/1598300732037-0682672155089", 3 { description: "This is my webhook, I like it a lot" } 4); 5console.log(JSON.stringify(webhook, null, 2)); 6// outputs: 7// { 8// "uid": "whe_FPYDtTL37ye13m3sJvtcdyuF", 9// "object": "webhook_endpoint", 10// "url": "https://postb.in/1598300732037-0682672155089", 11// "description": "This is my webhook, I like it a lot", 12// "filter": { 13// "enabled_events": [ 14// "*" 15// ] 16// }, 17// "status": { 18// "disabled": false 19// }, 20// "created": 1602078105978 21// }
webhooks.list([options]) ⇒ Promise.<object>
Lists all regsitered webhook endpoints.
Kind: static method of webhooks
Returns: Promise.<object> - A dictionary with a data property that contains an array, with each entry being a webhook object.
| Param | Type | Description |
|---|---|---|
| [options] | Object | List options. |
| options.starting_after | string | A cursor for use in pagination. starting_after is a webhook endpoint object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with whe_foo, your subsequent call can include starting_after=whe_foo in order to fetch the next page of the list. |
| options.limit | number | A limit on the number of webhook endpoints to be returned. Limit can range between 1 and 100, and the default is 10. |
Example
1const webhooks = await sdk.webhooks.list({ 2 limit: 1, 3}); 4console.log(JSON.stringify(webhooks, null, 2)); 5// outputs: 6// { 7// "object": "list", 8// "data": [ 9// { 10// "uid": "whe_FPYDtTL37ye13m3sJvtcdyuF", 11// "object": "webhook_endpoint", 12// "url": "https://postb.in/1598300732037-0682672155089", 13// "description": "This is my webhook, I like it a lot", 14// "filter": { 15// "enabled_events": ["*"] 16// }, 17// "status": { 18// "disabled": false, 19// "most_recent_delivery": { 20// "event_uid": "evt_5cmXN7kqdu5YY69HFKegmiGR", 21// "response_status_code": 200, 22// "response_headers": { 23// "content-length": "12", 24// "connection": "close", 25// "content-type": "application/json" 26// }, 27// "request_headers": { 28// "User-Agent": "Serverless-Webhook/0.1", 29// "Content-type": "application/json", 30// "X-Serverless-Delivery": "e1701c44-5d92-4515-8bfb-6c9173a89b60", 31// "X-Serverless-Event": "test.webhook.send2" 32// }, 33// "response_text": "{\"ok\": true}", 34// "error_message": null, 35// "timestamp": 1599595612876 36// } 37// }, 38// "created": 1599591851267, 39// "updated": 1599595613099 40// }, 41// ] 42// }
webhooks.get(uid) ⇒ Promise.<object>
Retrieves a webhook endpoint with the given ID.
Kind: static method of webhooks
Returns: Promise.<object> - A webhook endpoint if a valid webhook endpoint ID was provided.
| Param | Type | Description |
|---|---|---|
| uid | string | Webhook endpoint ID. |
Example
1const webhook = await sdk.webhooks.get("whe_FPYDtTL37ye13m3sJvtcdyuF"); 2console.log(JSON.stringify(webhook, null, 2)); 3// outputs: 4// { 5// "uid": "whe_FPYDtTL37ye13m3sJvtcdyuF", 6// "object": "webhook_endpoint", 7// "url": "https://postb.in/1598300732037-0682672155089", 8// "description": "This is my webhook, I like it a lot", 9// "filter": { 10// "enabled_events": ["*"] 11// }, 12// "status": { 13// "disabled": false, 14// "most_recent_delivery": { 15// "event_uid": "evt_5cmXN7kqdu5YY69HFKegmiGR", 16// "response_status_code": 200, 17// "response_headers": { 18// "content-length": "12", 19// "connection": "close", 20// "content-type": "application/json" 21// }, 22// "request_headers": { 23// "User-Agent": "Serverless-Webhook/0.1", 24// "Content-type": "application/json", 25// "X-Serverless-Delivery": "e1701c44-5d92-4515-8bfb-6c9173a89b60", 26// "X-Serverless-Event": "test.webhook.send2" 27// }, 28// "response_text": "{\"ok\": true}", 29// "error_message": null, 30// "timestamp": 1599595612876 31// } 32// }, 33// "created": 1599591851267, 34// "updated": 1599595613099 35// }
webhooks.update(uid) ⇒ Promise.<object>
Updates the registered webhook endpoint. You may edit the url, description, the list of filters, and the status of your endpoint.
Kind: static method of webhooks
Returns: Promise.<object> - Updated webhook endpoint.
| Param | Type | Description |
|---|---|---|
| uid | string | Webhook endpoint ID. |
| updates.url | string | HTTP webhook endpoint url, if updating. |
| updates.description | string | An optional updated description of what the webhook is used for. |
| updates.filter | Object | Optionally, update filter which events this endpoint should receive. An existing filter can reset by setting it to null. |
| updates.filter.enabled_events | Array.<string> | The list of events to enable for this endpoint. ["*"] indicates that all events are enabled. |
| updates.status.disabled | boolean | Enable/disable the webhook endpoint. |
Example
1const webhook = await sdk.webhooks.update("whe_FPYDtTL37ye13m3sJvtcdyuF", { 2 url: "http://437f01fa092e.ngrok.io", 3 filter: { 4 enabled_events: ["user.created", "member.invite.sent"], 5 }, 6}); 7console.log(JSON.stringify(webhook, null, 2)); 8// outputs: 9// { 10// "uid": "whe_FPYDtTL37ye13m3sJvtcdyuF", 11// "object": "webhook_endpoint", 12// "url": "http://437f01fa092e.ngrok.io", 13// "description": "This is my webhook, I like it a lot", 14// "filter": { 15// "enabled_events": [ 16// "user.created", 17// "member.invite.sent" 18// ] 19// }, 20// "status": { 21// "disabled": false 22// }, 23// "created": 1602078105978, 24// "updated": 1602078663800 25// }
webhooks.delete(uid) ⇒ Promise.<object>
Deletes the webhook endpoint with the given ID.
Kind: static method of webhooks
Returns: Promise.<object> - An object with the deleted webhook endpoints’s ID if a valid webhook endpoint ID was provided. Otherwise, this call throws an error, such as if the webhook endpoint has already been deleted.
| Param | Type | Description |
|---|---|---|
| uid | string | Webhook endpoint ID. |
Example
1const webhook = await sdk.webhooks.delete("whe_FPYDtTL37ye13m3sJvtcdyuF"); 2console.log(JSON.stringify(webhook, null, 2)); 3// outputs: 4// { 5// "uid": "whe_FPYDtTL37ye13m3sJvtcdyuF", 6// "object": "webhook_endpoint", 7// "url": "http://437f01fa092e.ngrok.io", 8// "description": "This is my webhook, I like it a lot", 9// "filter": { 10// "enabled_events": [ 11// "user.created", 12// "member.invite.sent" 13// ] 14// }, 15// "status": { 16// "disabled": false 17// }, 18// "created": 1602078105978, 19// "updated": 1602078663800 20// }
serverlessSDK.accessKeys : object
Create, get and delete Serverless Platform Access Keys for an Organization
Kind: instance namespace of ServerlessSDK
- .accessKeys :
object- .create(orgName, userName, accessKeyName) ⇒
Promise.<object> - .list(orgName) ⇒
Promise.<object> - .remove(orgName, uid) ⇒
Promise.<object> - .get() ⇒
Promise.<(object|null)>
- .create(orgName, userName, accessKeyName) ⇒
accessKeys.create(orgName, userName, accessKeyName) ⇒ Promise.<object>
Creates a new Access Key for a User within a Serverless Organization.
Kind: static method of accessKeys
| Param | Type | Description |
|---|---|---|
| orgName | string | The name of the Serverless Organization to create the Access Key for |
| userName | string | The name of the User within the Serverless Organization to create the Access Key for |
| accessKeyName | string | The name of the Access Key you would like to create |
Example
1const accessKey = await sdk.accessKeys.create(orgName, accessKeyName);
accessKeys.list(orgName) ⇒ Promise.<object>
Lists all Access Keys within a Serverless Organization.
Kind: static method of accessKeys
| Param | Type | Description |
|---|---|---|
| orgName | string | The name of the Serverless Organization to list Access Keys |
Example
1const accessKeys = await sdk.accessKeys.list(orgName);
accessKeys.remove(orgName, uid) ⇒ Promise.<object>
Delete an Access Key from a Serverless Organization.
Kind: static method of accessKeys
| Param | Type | Description |
|---|---|---|
| orgName | string | The name of the Serverless Organization that the Access Key belongs to |
| uid | string | The UID of the Access Key |
Example
1const accessKeys = await sdk.accessKeys.remove(orgName, uid);
accessKeys.get() ⇒ Promise.<(object|null)>
Get metadata for the Access Key configured under sdk.accessKey
Kind: static method of accessKeys
Example
1const accessKeyData = await sdk.accessKeys.get();
serverlessSDK.connections : object
Create, manage and sync Serverless Platform Connections between vendor accounts and their Serverless Organization.
Kind: instance namespace of ServerlessSDK
- .connections :
object- .create(orgUid, providerUid, accountAlias) ⇒
Promise.<object> - .list(orgUid) ⇒
Promise.<object> - .get(orgUid, connectionUid) ⇒
Promise.<object> - .getByOrgAndAccountAlias(orgUid, accountAlias) ⇒
Promise.<object> - .update(orgUid, connectionUid, providerUid, accountAlias, status) ⇒
Promise.<object> - .remove(orgUid, connectionUid) ⇒
Promise.<object> - .syncAll(orgUid) ⇒
Promise.<object> - .unsync(orgUid, connectionUid) ⇒
Promise.<object>
- .create(orgUid, providerUid, accountAlias) ⇒
connections.create(orgUid, providerUid, accountAlias) ⇒ Promise.<object>
Creates a new Connection between a vendor account and a Serverless Organization.
Kind: static method of connections
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to create a Connection in. |
| providerUid | string | The UID of an existing Serverless Provider tied to a vendor account within the Organization to use for this Connection. A vendor account (e.g. an AWS account) can only be registered once with a Connection, across all Serverless Organizations. They are globally unique. |
| accountAlias | string | An alias or nickname of the vendor account used to conveniently identify which account this Connection is used with. This must be unique within the Serverless Organization. |
connections.list(orgUid) ⇒ Promise.<object>
List all Connections within the Serverless Organization.
Kind: static method of connections
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to create a Connection in. |
connections.get(orgUid, connectionUid) ⇒ Promise.<object>
Get a single Connection within the Serverless Organization.
Kind: static method of connections
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to get a Connection in. |
| connectionUid | string | The UID of the Connection to get within the Serverless Organization. |
connections.getByOrgAndAccountAlias(orgUid, accountAlias) ⇒ Promise.<object>
Get a single Connection by Organization UID and vendor account alias within the Serverless Organization.
Kind: static method of connections
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to get a Connection in. |
| accountAlias | string | The alias of the Connection to get within the Serverless Organization. |
connections.update(orgUid, connectionUid, providerUid, accountAlias, status) ⇒ Promise.<object>
Update a single Connection within the Serverless Organization.
Kind: static method of connections
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to update a Connection in. |
| connectionUid | string | The UID of the Connection to update within the Serverless Organization. |
| providerUid | string | The updated Provider UID within the Connection. |
| accountAlias | string | The updated alias of the Connection. |
| status | string | The updated status of the Connection. |
connections.remove(orgUid, connectionUid) ⇒ Promise.<object>
Remove a single Connection within the Serverless Organization.
Kind: static method of connections
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to remove a Connection in. |
| connectionUid | string | The UID of the Connection to remove within the Serverless Organization. |
connections.syncAll(orgUid) ⇒ Promise.<object>
Run a sync operation across all Connections within the Serverless Organization. This only runs sync on Connections with an "inactive", "synced", "unsynced", "error" state. Call connections.list() to view status of all Connections.
Kind: static method of connections
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to sync all Connections in. |
connections.unsync(orgUid, connectionUid) ⇒ Promise.<object>
Run an unsync operation on a specific Connection within the Serverless Organization. This only runs sync on Connections with an "synced", "error" state. Call connections.list() to view status of all Connections.
Kind: static method of connections
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to sync all Connections in. |
| connectionUid | string | The UID of the Connection to unsync within the Serverless Organization. |
serverlessSDK.desktop : object
Interact with the Serverless Desktop back-end functions, like storing state for views.
Kind: instance namespace of ServerlessSDK
- .desktop :
object- .createSavedQuery(orgUid, appUid, serviceName, savedQuery) ⇒
Promise.<object> - .getSavedQuery(orgUid, appUid, serviceName, savedQueryUid) ⇒
Promise.<object> - .updateSavedQuery(orgUid, appUid, serviceName, savedQueryUid, savedQuery) ⇒
Promise.<object> - .deleteSavedQuery(orgUid, appUid, serviceName, savedQueryUid) ⇒
Promise.<object> - .listSavedQueries(orgUid, appUid, serviceName) ⇒
Promise.<object>
- .createSavedQuery(orgUid, appUid, serviceName, savedQuery) ⇒
desktop.createSavedQuery(orgUid, appUid, serviceName, savedQuery) ⇒ Promise.<object>
Create a Saved Query for a Service by specifying some data.
Kind: static method of desktop
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to create the Saved Query in. |
| appUid | string | The UID of the Serverless Application to create the Saved Query in. |
| serviceName | string | The name of the Serverless Service to create the Saved Query in. |
| savedQuery | string | The object of arbitrary data you would like to save for this Serverless Service. |
desktop.getSavedQuery(orgUid, appUid, serviceName, savedQueryUid) ⇒ Promise.<object>
Get Saved Query for a Service Stage via its key.
Kind: static method of desktop
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to get the Saved Query from. |
| appUid | string | The UID of the Serverless Application to get the Saved Query from. |
| serviceName | string | The name of the Serverless Service to get the Saved Query from. |
| savedQueryUid | string | The UID of the Saved Query to get for this Serverless Service. |
desktop.updateSavedQuery(orgUid, appUid, serviceName, savedQueryUid, savedQuery) ⇒ Promise.<object>
Update a Saved Query for a Service by specifying the UID and the data.
Kind: static method of desktop
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to create the Saved Query in. |
| appUid | string | The UID of the Serverless Application to create the Saved Query in. |
| serviceName | string | The name of the Serverless Service to create the Saved Query in. |
| savedQueryUid | string | The UID of the Saved Query to get for this Serverless Service. |
| savedQuery | string | The object of arbitrary data you would like to save for this Serverless Service. |
desktop.deleteSavedQuery(orgUid, appUid, serviceName, savedQueryUid) ⇒ Promise.<object>
Delete Saved Query for a Service Stage by specifying its key.
Kind: static method of desktop
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to delete the Saved Query from. |
| appUid | string | The UID of the Serverless Application to delete the Saved Query from. |
| serviceName | string | The name of the Serverless Service to delete the Saved Query from. |
| savedQueryUid | string | The UID of the Saved Query to delete for this Serverless Service. |
desktop.listSavedQueries(orgUid, appUid, serviceName) ⇒ Promise.<object>
List Saved Queries for a Service.
Kind: static method of desktop
| Param | Type | Description |
|---|---|---|
| orgUid | string | The UID of the Serverless Organization to list the Saved Queries from. |
| appUid | string | The UID of the Serverless Application to list the Saved Queries from. |
| serviceName | string | The name of the Serverless Service to list the Saved Queries from. |
serverlessSDK.logDestinations : object
Manage Log Destinations for your Organization
Log Destination is represented by CloudWatch Logs Destination resource that is responsible for forwarding logs from selected service to Kinesis streams. These logs are later forwarded form Kinesis streams to Elasticsearch service.
Kind: instance namespace of ServerlessSDK
- .logDestinations :
object- .getOrCreate([params]) ⇒
Promise.<object> - .remove([params]) ⇒
Promise.<object>
- .getOrCreate([params]) ⇒
logDestinations.getOrCreate([params]) ⇒ Promise.<object>
Get or Create Log Destination. If Log Destination already exists for a service in selected region and for selected stage, it will be returned, otherwise it will be created.
Kind: static method of logDestinations
| Param | Type | Description |
|---|---|---|
| [params] | Object | Get or Create params |
| params.orgUid | string | The UID of the Serverless Organization to create the Log Destination for. |
| params.appUid | string | The UID of the Serverless Application to create the Log Destination for. |
| params.serviceName | string | The name of the Serverless Service to create the Log Destination for. |
| params.stageName | string | The name of the Serverless Service Stage to create the Log Destination for. |
| params.regionName | string | The name of the AWS Region to create the Log Destination for. |
| params.accountId | string | The ID of the AWS Account to create the Log Destination for. |
Example
1const result = await sdk.logDestinations.getOrCreate({ 2 orgUid: "1234", 3 appUid: "123456789", 4 serviceName: "log-dest-integration-test-service-name", 5 stageName: "log-dest-integration-test-stage", 6 regionName: "us-east-1", 7 accountId: "111111111111", 8}); 9console.log(JSON.stringify(result, null, 2)); 10// outputs: 11// { 12// "destinationArn": "arn:aws:logs:us-east-1:111111111111:destination:c492b73f-3704-4d5b-839a-d4fbc7adc328#123456789#log-dest-integration-test-service-name#log-dest-integration-test-stage", 13// }
logDestinations.remove([params]) ⇒ Promise.<object>
Remove Log Destination
Kind: static method of logDestinations
| Param | Type | Description |
|---|---|---|
| [params] | Object | Remove params |
| params.orgUid | string | The UID of the Serverless Organization to remove the Log Destination from. |
| params.appUid | string | The UID of the Serverless Application to remove the Log Destination from. |
| params.serviceName | string | The name of the Serverless Service to remove the Log Destination from. |
| params.stageName | string | The name of the Serverless Service Stage to remove the Log Destination from. |
| params.regionName | string | The name of the AWS Region to remove the Log Destination from. |
Example
1await sdk.logDestinations.remove({ 2 orgUid: "1234", 3 appUid: "123456789", 4 serviceName: "log-dest-integration-test-service-name", 5 stageName: "log-dest-integration-test-stage", 6 regionName: "us-east-1", 7});
serverlessSDK.deploymentProfiles : object
Manage Deployment Profiles for your Organization
Kind: instance namespace of ServerlessSDK
- .deploymentProfiles :
object- .get([params]) ⇒
Promise.<Object> - .create([params]) ⇒
Promise.<Object> - .list([params]) ⇒
Promise.<array> - .setDefault([params]) ⇒
Promise.<Object>
- .get([params]) ⇒
deploymentProfiles.get([params]) ⇒ Promise.<Object>
Get a Deployment Profile associated with an Application
Kind: static method of deploymentProfiles
| Param | Type | Description |
|---|---|---|
| [params] | Object | Get params |
| params.orgName | string | The name of the Serverless Organization. |
| params.appName | string | The name of the Serverless Organization. |
| params.serviceName | string | The name of the Serverless Service. |
| params.stageName | string | The name of the Serverless Service Stage. |
deploymentProfiles.create([params]) ⇒ Promise.<Object>
Create a Deployment Profile
Kind: static method of deploymentProfiles
Returns: Promise.<Object> - Created Deployment Profile
| Param | Type | Description |
|---|---|---|
| [params] | Object | Create params |
| params.profileName | string | The name of the created Deployment Profile. |
| params.orgName | string | The name of the Serverless Organization. |
| params.description | string | Optional The description for the created Deployment Profile. |
| params.secrets | array | Optional The secrets for the created Deployment Profile. |
| params.safeguardsPolicies | array | Optional The safeguard policies for the created Deployment Profile. |
| params.providerCredentials | object | Optional The provider credentials for the created Deployment Profile. |
deploymentProfiles.list([params]) ⇒ Promise.<array>
List Deployment Profiles
Kind: static method of deploymentProfiles
Returns: Promise.<array> - Array of DeploymentProfile objects.
| Param | Type | Description |
|---|---|---|
| [params] | Object | List params |
| params.orgName | string | The name of the Serverless Organization. |
deploymentProfiles.setDefault([params]) ⇒ Promise.<Object>
Set default Deployment Profile for an Application
Kind: static method of deploymentProfiles
| Param | Type | Description |
|---|---|---|
| [params] | Object | Get params |
| params.orgName | string | The name of the Serverless Organization. |
| params.appName | string | The name of the Serverless Organization. |
| params.profileUid | string | The UID of the Deployment Profile that should be associated with an Application. |
serverlessSDK.organizations : object
Create, get and list Serverless Platform Organizations.
Kind: instance namespace of ServerlessSDK
- .organizations :
object- .get([params]) ⇒
object - .list([params]) ⇒
array - .create([params]) ⇒
object - .validate([params]) ⇒
array
- .get([params]) ⇒
organizations.get([params]) ⇒ object
Gets an Organization
Kind: static method of organizations
Returns: object - Returns the Organization record.
| Param | Type | Description |
|---|---|---|
| [params] | Object | Get organization params |
| params.orgName | string | The name of the Organization you wish to retrieve. |
organizations.list([params]) ⇒ array
List organizations
Kind: static method of organizations
Returns: array - Returns an array of Organizations
| Param | Type | Description |
|---|---|---|
| [params] | Object | List organizations params |
| params.username | string | The name of the User whose Organizations you wish to list. |
organizations.create([params]) ⇒ object
Creates an Organization and User if one does not exist.
Kind: static method of organizations
Returns: object - Returns the newly created Organization.
| Param | Type | Description |
|---|---|---|
| [params] | Object | Create organization params |
| params.orgName | string | The name of the Organization you wish to create. |
| params.username | string | Optional The username for a User that will be created if one does not exist. If it's not provided, it will default to params.orgName. |
| params.email | string | Optional The email that will be associated with created User. |
| params.password | string | Optional The password that will be associated with created User. |
organizations.validate([params]) ⇒ array
Validates whether a potential User and Organization name meets the Platform requirements. Most importantly, this calls the Platform to validate whether the User and Organization names are already taken. This method is necessary because every User must have an Organization and we want to be sure both namespaces are available, before creating one or the other. In the future, both of these records should be created in the back-end, not on the client-side. Until then, this method is essential.
Kind: static method of organizations
Returns: array - Returns an array of validation errors, if any. Otherwise, returns null.
| Param | Type | Description |
|---|---|---|
| [params] | Object | Validate params |
| params.orgName | string | The name of the Organization. |
| params.username | string | Optional The username for a User. If it's not provided, it will default to params.orgName. |
serverlessSDK.apps : object
Register, update, delete and list Applications
Kind: instance namespace of ServerlessSDK
- .apps :
object- .create([params]) ⇒
object - .get([params])
- .update([params]) ⇒
object - .remove([params])
- .list([params])
- .create([params]) ⇒
apps.create([params]) ⇒ object
Create an Application within an Organization
Kind: static method of apps
Returns: object - Returns a data object of the newly created Application
| Param | Type | Description |
|---|---|---|
| [params] | Object | Create app params |
| params.orgName | string | The name of the Organization you wish to create an Application in. |
| params.app.name | string | The name of the Application. |
| params.app.description | string | The description of the Application. |
| params.app.deploymentProfiles | object | An object of deployment profiles and stages. This structure is a bit confusing. Look at the back-end service for more details and hopefully we can design this more elegantly in the future. |
apps.get([params])
Get an Application within an Organization
Kind: static method of apps
| Param | Type | Description |
|---|---|---|
| [params] | Object | Get app params |
| params.orgName | string | The name of the Organization the Application belongs to. |
| params.appName | string | The name of the Application you want to retrieve. |
apps.update([params]) ⇒ object
Update an Application within an Organization
Kind: static method of apps
Returns: object - Returns a data object of the updated Application
| Param | Type | Description |
|---|---|---|
| [params] | Object | Update app params |
| params.orgName | string | The name of the Organization the Application belongs to. |
| params.app.name | string | The name of the Application you wish to update. This property cannot be updated due to current data modeling issues. |
| params.app.description | string | The description of the Application. This property can be updated. |
| params.app.deploymentProfiles | object | An object of deployment profiles and stages. This property can be updated. This structure is a bit confusing. Look at the back-end service for more details and hopefully we can design this more elegantly in the future. |
apps.remove([params])
Delete an Application within an Organization
Kind: static method of apps
| Param | Type | Description |
|---|---|---|
| [params] | Object | Update app params |
| params.orgName | string | The name of the Organization the Application belongs to. |
| params.appName | string | The name of the Application you wish to delete. |
apps.list([params])
List all Applications within an Organization
Kind: static method of apps
| Param | Type | Description |
|---|---|---|
| [params] | Object | Update app params |
| params.orgName | string | The name of the Organization the Application belongs to. |
serverlessSDK.metadata : object
Get Metadata for Serverless Platform
Kind: instance namespace of ServerlessSDK
metadata.get() ⇒ Promise.<Object>
Get Metadata for Serverless Platform, which includes informations about regions and runtimes that are supported by the platform.
Kind: static method of metadata
Returns: Promise.<Object> - A dictionary with an awsAccountId, supportedRegions and supportedRuntimes properties. Both supportedRuntimes and supportedRegions are arrays.
Example
1const metadata = await sdk.metadata.get(); 2console.log(JSON.stringify(metadata, null, 2)); 3// outputs: 4// { 5// "awsAccountId": "111111111111", 6// "supportedRuntimes": [ 7// "nodejs8.10", 8// "nodejs10.x", 9// "nodejs12.x", 10// "python2.7", 11// "python3.6", 12// "python3.7", 13// "python3.8" 14// ], 15// "supportedRegions": [ 16// "us-east-1", 17// "us-east-2", 18// "us-west-1", 19// "us-west-2", 20// "eu-central-1", 21// "eu-west-1", 22// "eu-west-2", 23// "eu-west-3", 24// "ap-northeast-1", 25// "ap-southeast-1", 26// "ap-southeast-2", 27// "eu-central-1", 28// "ap-south-1", 29// "ca-central-1", 30// "sa-east-1" 31// ] 32// }
serverlessSDK.config() ⇒ null
Updates the SDK configuration
Kind: instance method of ServerlessSDK
| Param | Type | Description |
|---|---|---|
| [config.accessKey] | string | Can either be a Serverless Platform Access Key or an ID Token. |
| [config.platformStage] | string | The Serverless Platform Stage you wish to interact with. This can also be set by the environment variable SERVERLESS_PLATFORM_STAGE= |
| [context.orgName] | string | The name of the Serverless Platform Organization you wish to interact with. If set, this value is used upon creating a Websockets connection, and auto-added to every Event you publish. |
| [context.orgUid] | string | The ID of the Serverless Platform Organization you wish to interact with. If set, this value is used upon creating a Websockets connection, and auto-added to every Event you publish. |
| [context.stageName] | string | The Serverless Platform Organization Stage you wish to interact with. If set, this value is auto-added to every Event you publish. |
| [context.appName] | string | The Serverless Platform Application you wish to interact with. If set, this value is auto-added to every Event you publish. |
| [context.instanceName] | string | The Serverless Platform Instance you wish to interact with. If set, this value is auto-added to every Event you publish. |
| [context.componentName] | string | The Serverless Platform Component you wish to interact with. If set, this value is auto-added to every Event you publish. |
| [context.componentVersion] | string | The Serverless Platform Component version you wish to interact with. If set, this value is auto-added to every Event you publish. |
Example
1const { ServerlessSDK } = require("@serverless/platform-client"); 2 3const sdk = new ServerlessSDK(); 4sdk.config({ 5 accessKey: "123456789", 6 context: { 7 orgName: "my-org", 8 orgUid: "1234", 9 stageName: "prod", 10 appName: "my-app", 11 instanceName: "my-instance", 12 }, 13});
serverlessSDK.getDomain(serviceName) ⇒ string
Gets a domain for a specific service: 'engine', 'registry', 'events-streaming'
Kind: instance method of ServerlessSDK
Returns: string - The domain of that service.
| Param | Type | Default | Description |
|---|---|---|---|
| serviceName | string | null | The name of the Serverless Platform Service you want the domain for. |
serverlessSDK.getUser() ⇒ object
Get User account
Kind: instance method of ServerlessSDK
Returns: object - Returns a user record.
serverlessSDK.getUserMeta() ⇒ object
Get User account meta information.
Kind: instance method of ServerlessSDK
Returns: object - Returns a data object of custom "meta" information.
serverlessSDK.saveUserMeta(userMeta) ⇒ object
Updates User account meta information. This method fetches meta information and merges it with the meta object you provide before saving. Please note that this does a shallow merge and not a deep merge. That means nested properties might be replaced.
Kind: instance method of ServerlessSDK
Returns: object - Returns a data object of User data.
| Param | Type | Description |
|---|---|---|
| userMeta | object | An object of new userMeta that will be automaticaly merged with the old user meta. |
serverlessSDK.validateUserAndOrgName(userAndOrgName) ⇒ array
arrayDeprecated
Validates whether a potential User and Organization name meets the Platform requirements. Most importantly, this calls the Platform to validate whether the User and Organization names are already taken. This method is necessary because every User must have an Organization and we want to be sure both namespaces are availbale, before creating one or the other. In the future, both of these records should be created in the back-end, not on the client-side. Until then, this method is essential.
Kind: instance method of ServerlessSDK
Returns: array - Returns an array of validation errors, if any. Otherwise, returns null.
| Param | Type | Description |
|---|---|---|
| userAndOrgName | string | The name of the User and Org name. |
serverlessSDK.createUserAndOrg(userAndOrgName) ⇒ object
objectDeprecated
In the Serverless Platform, every User must have an Organization by default. This method creates both a User and an Organization record, at the same time. Please note, the endpoint called is specific to Tenants (Organizations), which also has User creation logic within it. This API design is non-sensible and we should consider a better API design ASAP. Until then, this method abstracts over that.
Kind: instance method of ServerlessSDK
Returns: object - Returns the newly create Organization.
| Param | Type | Description |
|---|---|---|
| userAndOrgName | string | The name of the User and Org name. |
serverlessSDK.createOrg(userAndOrgName) ⇒ object
objectDeprecated
Creates an Organization.
Kind: instance method of ServerlessSDK
Returns: object - Returns the newly create Organization.
| Param | Type | Description |
|---|---|---|
| userAndOrgName | string | The name of the Organization you wish to create. WARNING: This also creates a User record if one does not exist under this Organization name. This API design needs improvement. |
serverlessSDK.getOrgByName(orgName) ⇒ object
objectDeprecated
Gets an Organization by Organization name.
Kind: instance method of ServerlessSDK
Returns: object - Returns the Organization record.
| Param | Type | Description |
|---|---|---|
| orgName | string | The name of the Organization you wish to retrieve. |
serverlessSDK.listOrgs(username) ⇒ object
objectDeprecated
Lists Organizations by User, whether the User is an Owner or a Member of a given Organization.
Kind: instance method of ServerlessSDK
Returns: object - Returns an array of Organizations
| Param | Type | Description |
|---|---|---|
| username | string | The name of the User whose Organizations you wish to list. |
serverlessSDK.createApp(orgName) ⇒ object
objectDeprecated
Create an Application within an Organization
Kind: instance method of ServerlessSDK
Returns: object - Returns a data object of the newly created Application
| Param | Type | Default | Description |
|---|---|---|---|
| orgName | string | null | The name of the Organization you wish to create an Application in. |
| app.name | string | The name of the Application. | |
| app.description | string | The description of the Application. | |
| app.deploymentProfiles | object | An object of deployment profiles and stages. This structure is a bit confusing. Look at the back-end service for more details and hopefully we can design this more elegantly in the future. |
serverlessSDK.updateApp(orgName) ⇒ object
objectDeprecated
Update an Application within an Organization
Kind: instance method of ServerlessSDK
Returns: object - Returns a data object of the updated Application
| Param | Type | Default | Description |
|---|---|---|---|
| orgName | string | null | The name of the Organization the Application belongs to. |
| app.name | string | The name of the Application you wish to update. This property cannot be updated due to current data modeling issues. | |
| app.description | string | The description of the Application. This property can be updated. | |
| app.deploymentProfiles | object | An object of deployment profiles and stages. This property can be updated. This structure is a bit confusing. Look at the back-end service for more details and hopefully we can design this more elegantly in the future. |
serverlessSDK.deleteApp(orgName, appName)
Deprecated
Delete an Application within an Organization
Kind: instance method of ServerlessSDK
| Param | Type | Default | Description |
|---|---|---|---|
| orgName | string | null | The name of the Organization the Application belongs to. |
| appName | string | null | The name of the Application you wish to delete. |
serverlessSDK.listApps(orgName)
Deprecated
List all Applications within an Organization
Kind: instance method of ServerlessSDK
| Param | Type | Default | Description |
|---|---|---|---|
| orgName | string | null | The name of the Organization the Application belongs to. |
serverlessSDK.createInitToken(orgName)
Create an initToken for a user and organization
Kind: instance method of ServerlessSDK
| Param | Type | Default | Description |
|---|---|---|---|
| orgName | string | null | The name of the Organization the Init Token belongs to. |
| template.type | string | Must be either s3, github, or existing. | |
| template.commands | Array.<string> | Array of commands executed by the user's shell env in order to fetch and set up the template |
serverlessSDK.getInitToken(initTokenUid)
Get an initToken by UID
Kind: instance method of ServerlessSDK
| Param | Type | Description |
|---|---|---|
| initTokenUid | string | Unique identifier of an initToken |
serverlessSDK.createProvider(orgUid, data)
Create a provider
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| data | * |
serverlessSDK.updateProvider(orgUid, providerUid, data)
Update a provider
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| providerUid | * |
| data | * |
serverlessSDK.setDefaultProvider(orgUid, providerUid)
Set a default provider
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| providerUid | * |
serverlessSDK.unsetDefaultProvider(orgUid, providerUid)
Unsets the default provider
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| providerUid | * |
serverlessSDK.deleteProvider(orgUid, providerUid)
Delete a provider
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| providerUid | * |
serverlessSDK.createProviderLink(orgUid, linkType, linkUid, providerUid)
Create a providerLink
Link type can be either service or instance
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| linkType | * |
| linkUid | * |
| providerUid | * |
serverlessSDK.deleteProviderLink(orgUid, linkType, linkUid, providerUid)
Delete a providerLink
Link type can be either service or instance
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| linkType | * |
| linkUid | * |
| providerUid | * |
serverlessSDK.getProviders(orgUid)
List providers by OrgUid
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
serverlessSDK.getProvider(orgUid, providerUid)
Get a Provider
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| providerUid | * |
serverlessSDK.getProvidersByOrgServiceInstance(orgUid, serviceUid, instanceUid)
Get providers by org, service, and instance Configuration set at the instance level will override defaults set at the service level
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| serviceUid | * |
| instanceUid | * |
serverlessSDK.getProvidersByLink(orgUid, linkType, linkUid)
List providers by Link
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| linkType | * |
| linkUid | * |
serverlessSDK.getAllowedProviders()
Returns the list of supported providers
Kind: instance method of ServerlessSDK
serverlessSDK.createParam(orgUid, linkType, linkUid, data)
Create a param and link it to a service or an instance
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| linkType | * |
| linkUid | * |
| data | * |
serverlessSDK.deleteParam(orgUid, linkType, linkUid, paramUid)
Destroy a param
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| linkType | * |
| linkUid | * |
| paramUid | * |
serverlessSDK.updateParam(orgUid, linkType, linkUid, paramUid, data)
Update a param
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| linkType | * |
| linkUid | * |
| paramUid | * |
| data | * |
serverlessSDK.getParams(orgUid, linkType, linkUid)
List params by service or instance
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| linkType | * |
| linkUid | * |
serverlessSDK.getParamsByOrgServiceInstance(orgUid, serviceUid, instanceUid)
List params by org, service, and instance
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| serviceUid | * |
| instanceUid | * |
serverlessSDK.getParamsAndProvidersByOrgServiceInstance(orgUid, serviceUid, instanceUid)
List parameters and providers by org, service, and instance
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| orgUid | * |
| serviceUid | * |
| instanceUid | * |
serverlessSDK.connect([options]) ⇒ null
Establishes a websockets connection with the Serverless Platform
Kind: instance method of ServerlessSDK
| Param | Type | Default | Description |
|---|---|---|---|
| [options] | Object | {} | Connection options. |
| [options.orgName] | string | Name of the Serverless Platform Org. If not specified, inherits from SDK context. | |
| [options.orgUid] | string | ID of the Serverless Platform Org. If not specified, inherits from SDK context. | |
| [options.onEvent] | onEvent | A function that handles events recieved from the Serverless Platform. | |
| [options.onDisconnect] | onDisconnect | Register a disconnect callback. | |
| [options.onError] | onError | Register an onError callback. | |
| [options.filter] | Object | Filters which events this connection should receive. | |
| [options.filter.stageName] | string | Tells the SDK to only receive events on a specific stage. | |
| [options.filter.appName] | string | Tells the SDK to only receive events on a specific app. | |
| [options.filter.instanceName] | string | Tells the SDK to only receive events on a specific service. | |
| [options.filter.events] | Array.<string> | ["*"] | Restrict the types of receivable events. ["*"] indicates that all events are enabled. |
serverlessSDK.disconnect() ⇒ null
Disconnects a websockets connection with the Serverless Platform
Kind: instance method of ServerlessSDK
serverlessSDK.isConnected() ⇒ boolean
Checks if the SDK is currently connected to the Serverless Platform
Kind: instance method of ServerlessSDK
Returns: boolean - Will return true if the websocket connection is active.
serverlessSDK.unpublishFromRegistry(registryPackage)
Unpublishes a package from the registry
Kind: instance method of ServerlessSDK
| Param | Type | Description |
|---|---|---|
| registryPackage | * | An object containing the properties of a registry package. |
serverlessSDK.publishToRegistry(registryPackage) ⇒ object
Publishes a package to the registry
Kind: instance method of ServerlessSDK
Returns: object - The published registry package is returned from the Platform API.
| Param | Type | Description |
|---|---|---|
| registryPackage | * | An object containing the properties of a registry package. |
serverlessSDK.getFromRegistry(name, version) ⇒ object
Fetches package/s from the registry
Kind: instance method of ServerlessSDK
Returns: object - Returns a registry package from the Registry.
| Param | Type | Default | Description |
|---|---|---|---|
| name | * | | The name of the registry package to fetch. If this is not provided, this method will return a list of everything in the registry. |
| version | * | | The version of the registry package to fetch. If this is not provided, this method will always return the latest version. |
serverlessSDK.generateInstanceId(orgUid, stageName, appUid, instanceName) ⇒ object
Returns a properly formatted ID for an Instance
Kind: instance method of ServerlessSDK
Returns: object - Returns a properly formatted ID for an Instance
| Param | Type | Description |
|---|---|---|
| orgUid | * | The Uid of the Serverless Platform Organization. |
| stageName | * | The name of the Serverless Platform Stage. |
| appUid | * | The Uid of the Serverless Platform Application. |
| instanceName | * | The name of the Serverless Platform Instance. |
serverlessSDK.validateInstance(instanceToValidate) ⇒ object
Validates the properties of an Instance, as well as auto-corrects shortened syntax (e.g. org => orgName)
Kind: instance method of ServerlessSDK
Returns: object - Returns a validated, formatted version of the Instance
| Param | Type | Description |
|---|---|---|
| instanceToValidate | * | The Serverless Platform Instance you want to validate. |
serverlessSDK.createInstance(orgName, stageName, appName, instanceName, instanceStatus) ⇒ object
Returns a new Instance as a Javascript object.
Kind: instance method of ServerlessSDK
Returns: object - Returns a new Instance definition as a Javascript Object.
| Param | Type | Default | Description |
|---|---|---|---|
| orgName | * | | The name of the Serverless Platform Organization. |
| stageName | * | | The name of the Serverless Platform Stage. |
| appName | * | | The name of the Serverless Platform Application. |
| instanceName | * | | The name of the Serverless Platform Instance. |
| instanceStatus | * | inactive | The status of the instance |
serverlessSDK.saveInstance(instanceRecord)
Saves an instance record, defined by createInstance
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| instanceRecord | * |
serverlessSDK.getInstance(orgName, stageName, appName, instanceName)
Get an Instance from the Serverless Platform by it's name and the names of its Organization, Stage, Application.
Kind: instance method of ServerlessSDK
| Param | Type | Default | Description |
|---|---|---|---|
| orgName | * | | The name of the Serverless Platform Organization. |
| stageName | * | | The name of the Serverless Platform Stage. |
| appName | * | | The name of the Serverless Platform Application. |
| instanceName | * | | The name of the Serverless Platform Instance. |
serverlessSDK.listInstances(orgName, orgUid)
List all Component Instances within an Org, given an org name or org UId
Kind: instance method of ServerlessSDK
| Param | Type | Default | Description |
|---|---|---|---|
| orgName | * | | Optional. Must include either orgName or orgUid. |
| orgUid | * | Optional. Must include either orgName or orgUid. |
serverlessSDK.run(action, instanceData, options)
Run an action on a Component Instance. Is an asynchronous call by default, but you can perform this synchronously if you set options.sync. Please note that synchronous runs have a 24 second timeout limit. That is not ideal for long operations, and is not recommended for deployments.
Kind: instance method of ServerlessSDK
| Param | Type |
|---|---|
| action | * |
| instanceData | * |
| options | * |
serverlessSDK.runFinish(method, instanceData, meta)
Run Finish
Kind: instance method of ServerlessSDK
| Param | Type | Default | Description |
|---|---|---|---|
| method | string | null | The Action that was performed on the Component. |
| instanceData | object | An object representing your Instance definition. | |
| meta | object | Useful metadata about the Component Action. |
serverlessSDK.deploy()
Performs a 'deploy' action and polls the 'getInstance' endpoint until its 'instanceStatus' reflects a successful deployment, or error.
Kind: instance method of ServerlessSDK
serverlessSDK.remove()
Performs a 'remove' action and polls the 'getInstance' endpoint until its 'instanceStatus' reflects a successful deployment, or error.
Kind: instance method of ServerlessSDK
serverlessSDK.startInterceptingLogs(eventType, context)
Intercepts console 'log' 'debug' and 'error' methods, and sends their data to the Serverless Platform as an Event, before writing to stdout.
Kind: instance method of ServerlessSDK
| Param | Type | Default | Description |
|---|---|---|---|
| eventType | * | | Optional. The event name used to publish logs. Defaults to "instance.logs". |
| context | * | Optional. Additional context added to the published log data. |
serverlessSDK.stopInterceptingLogs()
Stop intercepting console methods
Kind: instance method of ServerlessSDK
onEvent : function
onEvent callback
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| event | Object | Incoming event |
onDisconnect : function
onDisconnect callback
Kind: global typedef
| Param | Type | Description |
|---|---|---|
| closeEvent | Object | Websocket CloseEvent |
Publishing the SDK
Before publishing the SDK, be sure to run the pre-publish script, which browserifies the code and updates its documentation, by running: npm run pre-publish within the sdk folder.
© Serverless Inc.
No vulnerabilities found.
No security vulnerabilities found.