Class Fdk<TModel, TResource>

Type Parameters

TModel extends string = string
TResource extends string = string

Index

Methods - Entries

entryList

entryList(options?: EntryListOptions<TModel>): Promise<TypedEntryList<TModel>>
Loads entry list. Expects dmShortID / model to be set. If the model is not public, you also need to provide a token.
Parameters
- options: EntryListOptions<TModel> = ...
  options for list request.
Returns Promise<TypedEntryList<TModel>>
Example
```
// public model
const muffins = await fdk("stage").dm("83cc6374").model("muffin").entryList()
```
Example
```
// non-public model
const secrets = await fdk("stage").token(token).dm("83cc6374").model("secret").entryList()
```
- Defined in lib/api.ts:292

mapEntries

mapEntries(fn: any, options?: GenericListOptions): Promise<EntryResource[]>

Maps over entry list.

Parameters

fn: any
options: GenericListOptions = {}
options for entry list request.

Returns Promise<EntryResource[]>

Example

// public model
const muffins = fdk("stage").dm("83cc6374").model("muffin")
const res = await muffin.mapEntries((entry) => muffin.editEntry(entry.id, { name: entry.name + "!" }));
console.log("res", res);

getEntry

getEntry(entryID: string): Promise<TypedEntry<TModel>>
Loads a single entry. Expects dmShortID / model to be set. If the model is not public, you also need to provide a token.
Parameters
- entryID: string
Returns Promise<TypedEntry<TModel>>
Example
```
const muffin = await fdk("stage").dm("83cc6374").model("muffin").getEntry("1gOtzWvrdq")
```
- Defined in lib/api.ts:319

editEntrySafe

editEntrySafe(
entryID: string,
value: Partial<EntryInput<TModel>> & { _modified: string | Date },
): Promise<TypedEntry<TModel>>
Edits an entry with safe put. Expects dmShortID / model to be set. Expects a _modified field in the value. Will only update if the entry has not been changed since. If model PUT is not public, you also need to provide a token.
Parameters
- entryID: string
  id of entry to edit
- value: Partial<EntryInput<TModel>> & { _modified: string | Date }
  values to set. undefined fields are ignored
Returns Promise<TypedEntry<TModel>>
Example
```
const entry = await fdk("stage")
 .dm("83cc6374")
 .model("muffin")
 .editEntrySafe("1gOtzWvrdq", { name: "test", _modified: "2020-01-01T00:00:00.000Z"})
```
- Defined in lib/api.ts:337

getSchema

getSchema(): Promise<EntrySchema>
Loads the schema of a model. Expects dmShortID / model to be set.

Returns Promise<EntrySchema>
Example
```
const muffin = await fdk("stage").dm("83cc6374").model("muffin").getSchema()
```
- Defined in lib/api.ts:348

createEntry

createEntry(value: EntryInput<TModel>): Promise<TypedEntry<TModel>>
Creates a new entry. Expects dmShortID / model to be set. If model POST is not public, you also need to provide a token.
Parameters
- value: EntryInput<TModel>
  Entry value that satisfies the model's schema.
Returns Promise<TypedEntry<TModel>>
Example
```
const entry = await fdk("stage").dm("83cc6374").model("muffin").createEntry({ name: 'test' })
```
- Defined in lib/api.ts:455

editEntry

editEntry(
entryID: string,
value: Partial<EntryInput<TModel>>,
): Promise<TypedEntry<TModel>>
Edits an entry. Expects dmShortID / model to be set. If model PUT is not public, you also need to provide a token.
Parameters
- entryID: string
  id of entry to edit
- value: Partial<EntryInput<TModel>>
  values to set. undefined fields are ignored
Returns Promise<TypedEntry<TModel>>
Example
```
const entry = await fdk("stage").dm("83cc6374").model("muffin").editEntry("1gOtzWvrdq", { name: "test" })
```
- Defined in lib/api.ts:468

deleteEntry

deleteEntry(entryID: string): Promise<void>
Deletes an entry. Expects dmShortID / model to be set. If model DELETE is not public, you also need to provide a token.
Parameters
- entryID: string
  id of entry to delete
Returns Promise<void>
Example
```
await fdk("stage").dm("83cc6374").model("muffin").deleteEntry("1gOtzWvrdq")
```
- Defined in lib/api.ts:481

clean

clean(shouldClean?: boolean): Fdk<TModel, TResource>
If true, removes _links and _embedded from returned entries. Default: false.
Parameters
- shouldClean: boolean = true
  whether to clean entries (default: true)
Returns Fdk<TModel, TResource>
Example
```
const { items } = await fdk("stage").dm("83cc6374").model("muffin").clean().entryList()
// items won't have _links or _embedded
```
- Defined in lib/api.ts:1001

model

model<M extends string>(model: M): Fdk<M, TResource>
Sets the given model to use
Type Parameters
- M extends string
Parameters
- model: M
  name of the model
Returns Fdk<M, TResource>
- Defined in lib/api.ts:1013

dm

dm(dmShortID: string): Fdk<TModel, TResource>
Sets the short ID of the datamanager to use.
Parameters
- dmShortID: string
Returns Fdk<TModel, TResource>
- Defined in lib/api.ts:1033

publicApi

publicApi(): Promise<PublicApiRoot>
Returns the public api root endpoint. Expects dmShortID to be set.

Returns Promise<PublicApiRoot>
- Defined in lib/api.ts:1084

Methods - Assets

assetList

assetList(options: GenericListOptions): Promise<AssetList>

Loads asset list. Expects dmShortID / assetGroup to be set. If the assetGroup is not public, you also need to provide a token.

Parameters

options: GenericListOptions

Returns Promise<AssetList>

Example

// public assetGroup
const files = await fdk("stage").dm("83cc6374").assetGroup("avatars").assetList()

Example

// non-public assetGroup
const files = await fdk("stage").token(token).dm("83cc6374").assetGroup("avatars").assetList()

createAsset

createAsset(
config: { file: Blob; name: string; options: AssetCreateOptions },
): Promise<AssetResource>

Uploads an asset. Expects dmShortID / assetGroup / file to be set. If the assetGroup is not public, you also need to provide a token.

Parameters

config: { file: Blob; name: string; options: AssetCreateOptions }

Returns Promise<AssetResource>

Example

// browser example
document.getElementById("file").addEventListener("input", async (e) => {
  const [file] = e.target.files;
  const asset = await ecadmin.assetgroup("test").createAsset({ file })
});

Example

// node example
const buf = fs.readFileSync("venndiagram.png");
const file = new Blob([buf]);
const upload = await fdk("stage")
.dm("83cc6374")
.assetgroup("test")
.createAsset({ file, name: "venndiagram.png" });

createAssets

createAssets(
config: { files: Blob[]; options: AssetCreateOptions },
): Promise<AssetResource[]>

Uploads multiple assets. Expects dmShortID / assetGroup / files to be set. If the assetGroup is not public, you also need to provide a token.

Parameters

config: { files: Blob[]; options: AssetCreateOptions }

Returns Promise<AssetResource[]>

Example

// browser example
document.getElementById("file").addEventListener("input", async (e) => {
  const files = e.target.files;
  const asset = await ecadmin.assetgroup("test").createAssets({ files })
});

Example

// node example
const buf = fs.readFileSync("venndiagram.png");
const files = [new Blob([buf])];
const upload = await fdk("stage")
.dm("83cc6374")
.assetgroup("test")
.createAsset({ files });

deleteAsset

deleteAsset(assetID: string): Promise<void>
Deletes an asset. Expects dmShortID / assetGroup / assetID to be set. You probably also need to provide a token.
Parameters
- assetID: string
Returns Promise<void>
Example
```
await ecadmin.assetgroup("test").deleteAsset('xxxx');
```
- Defined in lib/api.ts:431

getAsset

getAsset(assetID: string): Promise<AssetResource>
Loads a single asset. Expects dmShortID / assetGroup to be set. If the asset group is not public, you also need to provide a token.
Parameters
- assetID: string
Returns Promise<AssetResource>
Example
```
const asset = await fdk("stage").dm("83cc6374").assetgroup("test").getAsset("tP-ZxpZZTGmbPnET-wArAQ")
```
- Defined in lib/api.ts:442

editAsset

editAsset(assetID: string, value: object): Promise<AssetResource>
Edits asset metadata. Expects dmShortID and assetGroup to be set.
Parameters
- assetID: string
- value: object
Returns Promise<AssetResource>
- Defined in lib/api.ts:653

dm

dm(dmShortID: string): Fdk<TModel, TResource>
Sets the short ID of the datamanager to use.
Parameters
- dmShortID: string
Returns Fdk<TModel, TResource>
- Defined in lib/api.ts:1033

assetGroup

assetGroup(assetGroup: string): Fdk<TModel, TResource>
Sets the name of the asset group to use.
Parameters
- assetGroup: string
  name of the asset group
Returns Fdk<TModel, TResource>
- Defined in lib/api.ts:1049

Methods - Admin

resourceList

resourceList(
    options?: GenericListOptions,
): Promise<
    TResource extends keyof ResourceRegistry
        ? ResourceRegistry[TResource<TResource>]
        : ResourceList,
>
Fetches resource list. Expects resource to be set. subdomain defaults to "datamanager". Fetches https://<subdomain>.entrecode.de/<resource>?_list=true&size=<options.size ?? 25>
Parameters
- options: GenericListOptions = {}
  options for list request.
Returns Promise<
    TResource extends keyof ResourceRegistry
        ? ResourceRegistry[TResource<TResource>]
        : ResourceList,
>
Example
```
const res = await fdk("stage").resource("template").resourceList()
```
- Defined in lib/api.ts:494

resourceGet

resourceGet(
    options: Record<string, any>,
): Promise<
    TResource extends keyof ResourceItemRegistry
        ? ResourceItemRegistry[TResource<TResource>]
        : any,
>
Fetches a single resource. Expects resource to be set. subdomain defaults to "datamanager". Pass identifying query params as options.
Parameters
- options: Record<string, any>
  query params to identify the resource.
Returns Promise<
    TResource extends keyof ResourceItemRegistry
        ? ResourceItemRegistry[TResource<TResource>]
        : any,
>
Example
```
const model = await fdk("stage").resource("model").resourceGet({ dataManagerID: 'x', modelID: 'y' })
```
- Defined in lib/api.ts:509

resourceEdit

resourceEdit(options: Record<string, any>, value: object): Promise<any>
Edits a single resource via PUT. Expects resource to be set. subdomain defaults to "datamanager". Pass identifying query params as options.
Parameters
- options: Record<string, any>
  query params to identify the resource.
- value: object
  the resource body to PUT.
Returns Promise<any>
Example
```
const model = await fdk("stage").resource("model").resourceEdit({ dataManagerID: 'x', modelID: 'y' }, { title: 'new' })
```
- Defined in lib/api.ts:525

resourceDelete

resourceDelete(options: Record<string, any>): Promise<Response>
Deletes a single resource. Expects resource to be set. subdomain defaults to "datamanager". Pass identifying query params as options.
Parameters
- options: Record<string, any>
  query params to identify the resource.
Returns Promise<Response>
Example
```
await fdk("stage").resource("model").resourceDelete({ dataManagerID: 'x', modelID: 'y' })
```
- Defined in lib/api.ts:538

raw

raw<T = any>(options: object, fetchOptions?: object): Promise<T>
Fetches raw route. Expects route to be set. subdomain defaults to "datamanager". Fetches https://<subdomain>.entrecode.de/<route>?<options> Use this when no other fdk method can give you your request.
Type Parameters
- T = any
Parameters
- options: object
  options that are converted to query params.
- OptionalfetchOptions: object
  (optional) options passed to fetch.
Returns Promise<T>
Example
```
const res = await fdk("stage").route("stats").raw()
```
- Defined in lib/api.ts:553

createDatamanager

createDatamanager(value: object): Promise<DatamanagerResource>
Creates a new datamanager.
Parameters
- value: object
Returns Promise<DatamanagerResource>
- Defined in lib/api.ts:564

editDatamanager

editDatamanager(dmID: string, value: object): Promise<DatamanagerResource>
Edits a datamanager. Expects dmID to be set.
Parameters
- dmID: string
- value: object
Returns Promise<DatamanagerResource>
- Defined in lib/api.ts:573

deleteDatamanager

deleteDatamanager(dmID: string): Promise<Response>
Deletes a datamanager. Expects dmID to be set.
Parameters
- dmID: string
Returns Promise<Response>
- Defined in lib/api.ts:582

createModel

createModel(value: object): Promise<ModelResource>
Creates a new model. Expects dmID to be set.
Parameters
- value: object
Returns Promise<ModelResource>
- Defined in lib/api.ts:593

editModel

editModel(modelID: string, value: object): Promise<ModelResource>
Edits a model. Expects dmID to be set.
Parameters
- modelID: string
- value: object
Returns Promise<ModelResource>
- Defined in lib/api.ts:602

deleteModel

deleteModel(modelID: string): Promise<Response>
Deletes a model. Expects dmID to be set.
Parameters
- modelID: string
Returns Promise<Response>
- Defined in lib/api.ts:611

createTemplate

createTemplate(value: object): Promise<TemplateResource>
Creates a new template.
Parameters
- value: object
Returns Promise<TemplateResource>
- Defined in lib/api.ts:622

createAssetGroup

createAssetGroup(value: object): Promise<AssetGroupResource>
Creates a new asset group. Expects dmID to be set.
Parameters
- value: object
Returns Promise<AssetGroupResource>
- Defined in lib/api.ts:633

editAssetGroup

editAssetGroup(assetGroupID: string, value: object): Promise<AssetGroupResource>
Edits an asset group. Expects dmID to be set.
Parameters
- assetGroupID: string
- value: object
Returns Promise<AssetGroupResource>
- Defined in lib/api.ts:642

editDmClient

editDmClient(clientID: string, value: object): Promise<ClientResource>
Edits a DM client. Expects dmID to be set.
Parameters
- clientID: string
- value: object
Returns Promise<ClientResource>
- Defined in lib/api.ts:664

createRole

createRole(value: object): Promise<RoleResource>
Creates a new role. Expects dmID to be set.
Parameters
- value: object
Returns Promise<RoleResource>
- Defined in lib/api.ts:675

editRole

editRole(roleID: string, value: object): Promise<RoleResource>
Edits a role. Expects dmID to be set.
Parameters
- roleID: string
- value: object
Returns Promise<RoleResource>
- Defined in lib/api.ts:684

deleteRole

deleteRole(roleID: string): Promise<Response>
Deletes a role. Expects dmID to be set.
Parameters
- roleID: string
Returns Promise<Response>
- Defined in lib/api.ts:693

editDmAccount

editDmAccount(accountID: string, value: object): Promise<AccountResource>
Edits a DM account. Expects dmID to be set.
Parameters
- accountID: string
- value: object
Returns Promise<AccountResource>
- Defined in lib/api.ts:704

deleteDmAccount

deleteDmAccount(accountID: string): Promise<Response>
Deletes a DM account. Expects dmID to be set.
Parameters
- accountID: string
Returns Promise<Response>
- Defined in lib/api.ts:713

getStats

getStats(options?: object): Promise<any>
Loads datamanager stats.
Parameters
- options: object = {}
Returns Promise<any>
- Defined in lib/api.ts:724

getHistory

getHistory(options?: object): Promise<HistoryList>
Loads dm-history entries.
Parameters
- options: object = {}
Returns Promise<HistoryList>
- Defined in lib/api.ts:735

createAccountClient

createAccountClient(value: object): Promise<ClientResource>
Creates an account client.
Parameters
- value: object
Returns Promise<ClientResource>
- Defined in lib/api.ts:746

editAccountClient

editAccountClient(clientID: string, value: object): Promise<ClientResource>
Edits an account client.
Parameters
- clientID: string
- value: object
Returns Promise<ClientResource>
- Defined in lib/api.ts:755

deleteAccountClient

deleteAccountClient(clientID: string): Promise<Response>
Deletes an account client.
Parameters
- clientID: string
Returns Promise<Response>
- Defined in lib/api.ts:764

createGroup

createGroup(value: object): Promise<GroupResource>
Creates a group.
Parameters
- value: object
Returns Promise<GroupResource>
- Defined in lib/api.ts:775

editGroup

editGroup(groupID: string, value: object): Promise<GroupResource>
Edits a group.
Parameters
- groupID: string
- value: object
Returns Promise<GroupResource>
- Defined in lib/api.ts:784

deleteGroup

deleteGroup(groupID: string): Promise<Response>
Deletes a group.
Parameters
- groupID: string
Returns Promise<Response>
- Defined in lib/api.ts:793

createInvite

createInvite(value: object): Promise<InviteResource>
Creates an invite.
Parameters
- value: object
Returns Promise<InviteResource>
- Defined in lib/api.ts:804

editInvite

editInvite(inviteID: string, value: object): Promise<InviteResource>
Edits an invite.
Parameters
- inviteID: string
- value: object
Returns Promise<InviteResource>
- Defined in lib/api.ts:813

deleteInvite

deleteInvite(inviteID: string): Promise<Response>
Deletes an invite.
Parameters
- inviteID: string
Returns Promise<Response>
- Defined in lib/api.ts:822

editAccount

editAccount(accountID: string, value: object): Promise<AccountResource>
Edits an account.
Parameters
- accountID: string
- value: object
Returns Promise<AccountResource>
- Defined in lib/api.ts:833

listTokens

listTokens(accountID: string): Promise<TokenList>
Lists tokens for an account.
Parameters
- accountID: string
Returns Promise<TokenList>
- Defined in lib/api.ts:844

createToken

createToken(accountID: string): Promise<TokenResource>
Creates a token for an account.
Parameters
- accountID: string
Returns Promise<TokenResource>
- Defined in lib/api.ts:853

deleteToken

deleteToken(accountID: string, accessTokenID: string): Promise<Response>
Deletes a token for an account.
Parameters
- accountID: string
- accessTokenID: string
Returns Promise<Response>
- Defined in lib/api.ts:862

dmID

dmID(dmID: any): Fdk<TModel, TResource>
Sets the (long) ID of the datamanager to use
Parameters
- dmID: any
Returns Fdk<TModel, TResource>
- Defined in lib/api.ts:1041

subdomain

subdomain(subdomain: string): Fdk<TModel, TResource>
Sets the subdomain to use.
Parameters
- subdomain: string
  subdomain
Returns Fdk<TModel, TResource>
- Defined in lib/api.ts:1061

resource

resource<R extends string>(resource: R): Fdk<TModel, R>
Sets the name of the resource to use.
Type Parameters
- R extends string
Parameters
- resource: R
  name of the resource
Returns Fdk<TModel, R>
- Defined in lib/api.ts:1069

route

route(route: string): Fdk<TModel, TResource>
Sets the route to use.
Parameters
- route: string
Returns Fdk<TModel, TResource>
- Defined in lib/api.ts:1076

getDatamanager

getDatamanager(dmID: string): Promise<DatamanagerResource>
Loads a DatamanagerResource by its long id. Requires token.
Parameters
- dmID: string
Returns Promise<DatamanagerResource>
- Defined in lib/api.ts:1092

dmList

dmList(options?: GenericListOptions): Promise<DatamanagerList>
Loads datamanager list. Requires auth.
Parameters
- options: GenericListOptions = {}
  options for list request.
Returns Promise<DatamanagerList>
Example
```
const dms = await fdk("stage").dmList()
```
- Defined in lib/api.ts:1105

modelList

modelList(options?: GenericListOptions): Promise<ModelList>
Loads model list. Expects dmID to be set. Requires auth.
Parameters
- options: GenericListOptions = {}
  options for entry list request.
Returns Promise<ModelList>
Example
```
const models = await fdk("stage").dmID("254a03f1-cb76-4f1e-a52a-bbd4180ca10c").modelList()
```
- Defined in lib/api.ts:1117

Methods - Auth

storageAdapter

storageAdapter(storageAdapter: StorageAdapter): Fdk<TModel, TResource>
Defines a custom storage to use for auth data. In most cases, this should not be needed. By default, auth will be stored in-memory, using a JS Map. This should be fine for NodeJS. In the Browser, it's better to use oidc-client and ignore all Auth methods here.
Parameters
- storageAdapter: StorageAdapter
Returns Fdk<TModel, TResource>
Example
```
// using Cookies
import Cookies from "js-cookie";
let fdk = fdk("stage").storageAdapter(Cookies);
await fdk.dm("83cc6374").model("my-protected-model").entryList();
```
- Defined in lib/api.ts:879

loginEc

loginEc(config: { email: string; password: string }): Promise<any>
Login with the given ec user. Only needed when using manual auth.
Parameters
- config: { email: string; password: string }
Returns Promise<any>
- Defined in lib/api.ts:938

loginPublic

loginPublic(config: any): Promise<any>
Login with the given public user. Only needed when using manual auth.
Parameters
- config: any
Returns Promise<any>
- Defined in lib/api.ts:947

logoutPublic

logoutPublic(): Promise<void>
Logs out the current public user. Only needed when using manual auth.

Returns Promise<void>
- Defined in lib/api.ts:957

logoutEc

logoutEc(): Promise<void>
Logs out the current ec user. Only needed when using manual auth.

Returns Promise<void>
- Defined in lib/api.ts:967

token

token(token: string): Fdk<TModel, TResource>
Sets the token to use in requests. Intended for usage with a fixed token in NodeJS.
Parameters
- token: string
Returns Fdk<TModel, TResource>
- Defined in lib/api.ts:1021

Class Fdk<TModel, TResource>

Type Parameters

Index

Methods - Entries

Methods - Assets

Methods - Admin

Methods - Auth

Methods - Entries

entryList

Parameters

Returns Promise<TypedEntryList<TModel>>

Example

Example

mapEntries

Parameters

Returns Promise<EntryResource[]>

Example

getEntry

Parameters

Returns Promise<TypedEntry<TModel>>

Example

editEntrySafe

Parameters

Returns Promise<TypedEntry<TModel>>

Example

getSchema

Returns Promise<EntrySchema>

Example

createEntry

Parameters

Returns Promise<TypedEntry<TModel>>

Example

editEntry

Parameters

Returns Promise<TypedEntry<TModel>>

Example

deleteEntry

Parameters

Returns Promise<void>

Example

clean

Parameters

Returns Fdk<TModel, TResource>

Example

model

Type Parameters

Parameters

Returns Fdk<M, TResource>

dm

Parameters

Returns Fdk<TModel, TResource>

publicApi

Returns Promise<PublicApiRoot>

Methods - Assets

assetList

Parameters

Returns Promise<AssetList>

Example

Example

createAsset

Parameters

Returns Promise<AssetResource>

Example

Example

createAssets

Parameters

Returns Promise<AssetResource[]>

Example

Example

deleteAsset

Parameters

Returns Promise<void>

Example

getAsset

Parameters

Returns Promise<AssetResource>

Example

editAsset

Parameters

Returns Promise<AssetResource>

Returns Promise<
TResource extends keyof ResourceRegistry
? ResourceRegistry[TResource<TResource>]
: ResourceList,
>

Returns Promise<
TResource extends keyof ResourceItemRegistry
? ResourceItemRegistry[TResource<TResource>]
: any,
>