@smapiot/piral-cloud-node 0.12.2-pre.20220801.2

package/lib/index.d.ts

@@ -0,0 +1,675 @@
+declare module "@smapiot/piral-cloud-node" {
+  /**
+   * The options for creating a new service client.
+   */
+  export interface CreateServiceClientOptions {
+    /**
+     * Defines the host to talk to. Set this if you want to communicate
+     * with your own feed service instance.
+     * @default https://feed.piral.cloud
+     */
+    host?: string;
+    /**
+     * Defines the API key to use for making the HTTP calls. Needs
+     * to be provided.
+     */
+    apiKey: string;
+  }
+
+  /**
+   * Creates a new service client for use in Node.js-based applications.
+   * @param options The options for creating the client.
+   * @returns The created service client.
+   */
+  export function createServiceClient(options: CreateServiceClientOptions): FeedServiceApiClient;
+
+  export class FeedServiceApiClient {
+    constructor(private http: FetchClient, host?: string);
+    getUrl(path: string): string;
+    getEvents(): string;
+    getPilets(): Promise<Array<PiletMetadataDTO>>;
+    doAny<T>(path: string, init?: RequestInit): Promise<T>;
+    doGet<T>(path: string, init?: RequestInit): Promise<T>;
+    doPost<T>(path: string, content: any, init?: RequestInit): Promise<T>;
+    doPut<T>(path: string, content: any, init?: RequestInit): Promise<T>;
+    doDelete<T>(path: string, init?: RequestInit): Promise<T>;
+    doQueryFeeds(): Promise<FeedsDTO>;
+    doQueryFeed(feed: string): Promise<FeedDTO>;
+    doQueryPages(feed: string): Promise<PagesDTO>;
+    doPublishPage(feed: string, content: PagePublishDetails): Promise<unknown>;
+    doQueryAllPilets(feed: string, tag?: string, view?: "all" | "selected"): Promise<SelectedPiletsDTO>;
+    doQueryUploadedPilets(feed: string, name: string, offset?: string, count?: string): Promise<UploadedPiletsDTO>;
+    doPublishPilet(feed: string, tag: string, file: File): Promise<unknown>;
+    doQueryCurrentPilets(feed: string): Promise<Array<PiletMetadataDTO>>;
+    doQueryFeedExists(feed: string): Promise<FeedCheckDTO>;
+    doQueryApiKeyScopes(): Promise<ApiKeyScopesDTO>;
+    doQueryApiKeys(feed: string): Promise<ApiKeysDTO>;
+    doQueryFeedApiKeys(feed: string): Promise<ApiKeysDTO>;
+    doQueryGeneralApiKeys(): Promise<ApiKeysDTO>;
+    doQueryRules(feed: string): Promise<RulesDTO>;
+    doCreateFeed(content: FeedCreateDetails): Promise<unknown>;
+    doAddRule(feed: string, content: RuleCreateDetails): Promise<unknown>;
+    doGenerateApiKey(feed: string, content: ApiKeyCreateDetails): Promise<GeneratedApiKeyDTO>;
+    doGenerateFeedApiKey(feed: string, content: ApiKeyCreateDetails): Promise<GeneratedApiKeyDTO>;
+    doGenerateGeneralApiKey(content: ApiKeyCreateDetails): Promise<GeneratedApiKeyDTO>;
+    doDeleteFeed(feed: string): Promise<unknown>;
+    doRevokeGeneralApiKey(id: string): Promise<unknown>;
+    doRevokeApiKey(feed: string, id: string): Promise<unknown>;
+    doRevokeFeedApiKey(feed: string, id: string): Promise<unknown>;
+    doDeletePilet(feed: string, id: string): Promise<unknown>;
+    doDeleteRule(feed: string, id: string): Promise<unknown>;
+    doUpdateRule(feed: string, id: string, content: RuleUpdateDetails): Promise<unknown>;
+    doUpdatePilet(feed: string, id: string, content: PiletUpdateDetails): Promise<unknown>;
+    doUpdateFeed(feed: string, content: FeedUpdateDetails): Promise<unknown>;
+    doUpdateApiKey(feed: string, id: string, content: ApiKeyUpdateDetails): Promise<unknown>;
+    doUpdateFeedApiKey(feed: string, id: string, content: ApiKeyUpdateDetails): Promise<unknown>;
+    doUpdateGeneralApiKey(id: string, content: ApiKeyUpdateDetails): Promise<unknown>;
+    doQueryAudits(offset?: string, count?: string, areaName?: string, areaId?: string, objectId?: string, userId?: string): Promise<AuditsDTO>;
+    doQueryAudit(id: string): Promise<AuditDTO>;
+    doQueryAllUsers(q: string): Promise<AllUsersDTO>;
+    doQueryFeedContributors(feed: string): Promise<FeedContributorsDTO>;
+    doPutFeedContributors(feed: string, content: ContributorUpdateDetails): Promise<unknown>;
+    doQueryConfigs(feed: string, pilet: string): Promise<ConfigsDTO>;
+    doQueryConfig(feed: string, pilet: string, config: string): Promise<ConfigDTO>;
+    doAddConfig(feed: string, pilet: string, content: ConfigCreateDetails): Promise<unknown>;
+    doDeleteConfig(feed: string, pilet: string, config: string): Promise<unknown>;
+    doUpdateConfig(feed: string, pilet: string, config: string, content: ConfigUpdateDetails): Promise<unknown>;
+    doQueryEntities(feed: string): Promise<EntitiesDTO>;
+    doQueryEntity(feed: string, id: string): Promise<EntityDTO>;
+    doAddEntity(feed: string, content: EntityCreateDetails): Promise<unknown>;
+    doDeleteEntity(feed: string, id: string): Promise<EntityDTO>;
+    doUpdateEntity(feed: string, id: string, content: EntityUpdateDetails): Promise<unknown>;
+    doQueryUsers(): Promise<UsersDTO>;
+    doQueryUser(id: string): Promise<UserDTO>;
+    doAddUser(content: UserCreateDetails): Promise<ChangedUserDTO>;
+    doDeleteUser(id: string): Promise<UserDTO>;
+    doUpdateUser(id: string, content: UserUpdateDetails): Promise<ChangedUserDTO>;
+    doQueryCustomRules(): Promise<CustomRuleModulesDTO>;
+    doAddCustomRules(file: string, content: string): Promise<ChangedCustomRuleModuleDTO>;
+    doDeleteCustomRule(file: string): Promise<ChangedCustomRuleModuleDTO>;
+    doQueryCustomRuleDetails(file: string): Promise<CustomRuleDetailsDTO>;
+    doTestRule(feed: string, rule: string, content: TestRuleDetails): Promise<TestRuleResultDTO>;
+    doQueryCurrentUser(): Promise<CurrentUserDTO>;
+    doUpdateCurrentUser(content: CurrentUserUpdateDetails): Promise<ChangedUserDTO>;
+    doQueryStatus(ac?: AbortController): Promise<StatusDTO>;
+    doQueryStatistics(ac?: AbortController): Promise<StatisticsDTO>;
+    doQueryRulesSchema(ac?: AbortController): Promise<any>;
+    doQueryFeedAnalysis(feed: string, ac?: AbortController): Promise<FeedAnalysisDTO>;
+    doRecheckDomains(feed: string, domains: Array<string>, ac?: AbortController): Promise<unknown>;
+    doQueryFeedStatistics(feed: string, from: string, to: string, ac?: AbortController): Promise<FeedStatisticsDTO>;
+    doQueryAdminFeedStatistics(offset?: string, count?: string, ac?: AbortController): Promise<AdminStatisticsDTO>;
+    doQueryAdminFeedStatisticsDetails(feed: string, from: string, to: string, ac?: AbortController): Promise<AdminStatisticsDetailsDTO>;
+    doQueryNpmRegistry(feed: string, ac?: AbortController): Promise<NpmRegistryDTO>;
+    doQueryNpmPackage(feed: string, name: string, ac?: AbortController): Promise<NpmPackageDTO>;
+    doUploadNpmPackage(feed: string, name: string, body: any, ac?: AbortController): Promise<void>;
+    doDownloadFile(fileUrl: string, ac?: AbortController): Promise<Blob>;
+  }
+
+  export interface FetchClient {
+    getAuthorizationHeader(): Promise<string>;
+    fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+    Headers: {
+      new (init?: HeadersInit): Headers;
+      prototype: Headers;
+    };
+    FormData: {
+      new (form?: HTMLFormElement): FormData;
+      prototype: FormData;
+    };
+  }
+
+  export interface PiletMetadataDTO {
+    /**
+     * The name of the pilet, i.e., the package id.
+     */
+    name: string;
+    /**
+     * The version of the pilet. Should be semantically versioned.
+     */
+    version: string;
+    /**
+     * Provides the version of the specification for this pilet.
+     */
+    spec: string;
+    /**
+     * The reference name for the global require.
+     */
+    requireRef: string;
+    /**
+     * The computed integrity of the pilet.
+     */
+    integrity?: string;
+    /**
+     * The content of a v0 pilet. If the content is not available
+     * the link will be used (unless caching has been activated).
+     */
+    content?: string;
+    /**
+     * If available indicates that the pilet should not be cached.
+     * In case of a string this is interpreted as the expiration time
+     * of the cache. In case of an accurate hash this should not be
+     * required or set.
+     */
+    noCache?: boolean | string;
+    /**
+     * The computed hash value of the pilet's content. Should be
+     * accurate to allow caching.
+     */
+    hash?: string;
+    /**
+     * The link for retrieving the content of the pilet.
+     */
+    link: string;
+    /**
+     * Optionally provides some custom metadata for the pilet.
+     */
+    custom?: any;
+    /**
+     * Optionally provides some configuration to be used in the pilet.
+     */
+    config?: Record<string, any>;
+    /**
+     * Additional shared dependency script files.
+     */
+    dependencies?: Record<string, string>;
+  }
+
+  export interface FeedsDTO extends ApiData<FeedDTO> {
+    used: number;
+    maximum: number;
+  }
+
+  export type FeedDTO = ShortFeedDTO | FullFeedDTO;
+
+  export interface PagesDTO extends ApiData<PageDTO> {
+    feed: string;
+  }
+
+  export interface PagePublishDetails {
+    version: string;
+    type: "custom" | "none" | "docs" | "siteless";
+    embed: "yes" | "no";
+    options?: any;
+    files?: Array<[string, Blob]>;
+  }
+
+  export interface SelectedPiletsDTO extends ApiData<PiletDTO> {
+    enabled: Array<string>;
+    bundled: Array<string>;
+    feed: string;
+    tags: Array<string>;
+  }
+
+  export interface UploadedPiletsDTO extends ApiPaginatedData<PiletDTO> {}
+
+  export interface FeedCheckDTO {
+    exists: boolean;
+    self: boolean;
+    feed: string;
+  }
+
+  export interface ApiKeyScopesDTO extends ApiData<string> {
+    feedScopes: Array<string>;
+    generalScopes: Array<string>;
+  }
+
+  export interface ApiKeysDTO extends ApiData<ApiKeyDTO> {
+    feed: string;
+  }
+
+  export interface RulesDTO extends ApiData<RuleDTO> {
+    feed: string;
+  }
+
+  export interface FeedCreateDetails {
+    id: string;
+    description: string;
+    hosts?: Array<string>;
+    integrity?: boolean;
+  }
+
+  export interface RuleCreateDetails {
+    pilet: string;
+    description: string;
+    definition: any;
+    mode: "allow" | "block";
+    meta?: string;
+  }
+
+  export interface ApiKeyCreateDetails {
+    name: string;
+    description: string;
+    expires?: string;
+    constraints?: Array<string>;
+    scopes?: Array<string>;
+  }
+
+  export interface GeneratedApiKeyDTO {
+    feed: string;
+    id: string;
+    name: string;
+    description: string;
+    expires: string;
+    apiKey: string;
+  }
+
+  export interface RuleUpdateDetails {
+    description?: string;
+    order?: number;
+    definition?: any;
+    mode?: string;
+    meta?: string;
+  }
+
+  export interface PiletUpdateDetails {
+    selected?: boolean;
+    enabled?: boolean;
+    bundled?: boolean;
+  }
+
+  export interface FeedUpdateDetails {
+    description?: string;
+    hosts?: Array<string>;
+    active?: boolean;
+    hook?: string;
+    integrity?: boolean;
+    contributors?: Array<string>;
+    domains?: Array<string>;
+    sources?: Array<{
+      type: string;
+      source: string;
+    }>;
+  }
+
+  export interface ApiKeyUpdateDetails {
+    description?: string;
+    name?: string;
+    expires?: string;
+  }
+
+  export interface AuditsDTO extends ApiPaginatedData<AuditDTO> {}
+
+  export interface AuditDTO {
+    id: string;
+    userId: string;
+    time: string;
+    actionName: string;
+    areaName: string;
+    areaId: string;
+    objectId: string;
+    details: string;
+  }
+
+  export interface AllUsersDTO extends ApiData<ServiceUserDTO> {}
+
+  export interface FeedContributorsDTO extends ApiData<FeedContributorDTO> {
+    canEdit: boolean;
+  }
+
+  export interface ContributorUpdateDetails {
+    items: Array<{
+      id: string;
+      constraints: Array<string>;
+    }>;
+  }
+
+  export interface ConfigsDTO extends ApiData<ConfigDTO> {
+    feed: string;
+    pilet: string;
+  }
+
+  export interface ConfigDTO {
+    name: string;
+    value: any;
+    feed: string;
+    pilet: string;
+    created: string;
+    changed: string;
+  }
+
+  export interface ConfigCreateDetails {
+    name: string;
+    value: any;
+  }
+
+  export interface ConfigUpdateDetails {
+    value: any;
+  }
+
+  export interface EntitiesDTO extends ApiData<EntityDTO> {
+    feed: string;
+  }
+
+  export interface EntityDTO {
+    id: string;
+    feed: string;
+    type: string;
+    name: string;
+    pilet: string;
+    description: string;
+    order: number;
+    changed: string;
+  }
+
+  export interface EntityCreateDetails {
+    pilet: string;
+    name: string;
+    description: string;
+    type: string;
+  }
+
+  export interface EntityUpdateDetails {
+    description?: string;
+    order?: number;
+  }
+
+  export interface UsersDTO extends ApiData<UserDTO> {}
+
+  export interface UserDTO {
+    id: string;
+    name: string;
+    provider: string;
+    plan: string;
+    role: string;
+    created: string;
+    changed: string;
+    self: boolean;
+  }
+
+  export interface UserCreateDetails {
+    id: string;
+    provider: string;
+    name?: string;
+    plan?: string;
+    role?: string;
+  }
+
+  export interface ChangedUserDTO {
+    id: string;
+    passphrase: string;
+    success: boolean;
+  }
+
+  export interface UserUpdateDetails {
+    name?: string;
+    provider?: string;
+    plan?: string;
+    role?: string;
+    resetpass?: boolean;
+  }
+
+  export interface CustomRuleModulesDTO {
+    items: Array<CustomRuleModuleDTO>;
+  }
+
+  export interface ChangedCustomRuleModuleDTO {
+    success: boolean;
+    file: string;
+    rules: Array<string>;
+  }
+
+  export interface CustomRuleDetailsDTO {
+    file: string;
+    content: string;
+    rules?: Array<string>;
+    error?: string;
+  }
+
+  export interface TestRuleDetails {
+    headers: Record<string, string>;
+    query: Record<string, string>;
+  }
+
+  export interface TestRuleResultDTO {
+    result: boolean;
+  }
+
+  export interface CurrentUserDTO {
+    id: string;
+    name: string;
+    provider: string;
+    plan: string;
+    role: string;
+    created: string;
+    changed: string;
+    settings: Record<string, any>;
+  }
+
+  export interface CurrentUserUpdateDetails {
+    name?: string;
+    resetpass?: boolean;
+    oldPassword?: string;
+    newPassword?: string;
+    settings?: Record<string, any>;
+  }
+
+  export interface StatusDTO {
+    instanceId: string;
+    started: string;
+    status: "healthy" | "unhealthy";
+    modules: Array<string>;
+    healthy: boolean;
+    version: string;
+    requests: {
+      count: number;
+      avg: number;
+    };
+    ping: string;
+  }
+
+  export interface StatisticsDTO {
+    accounts: number;
+    apiKeys: number;
+    feeds: number;
+    piletAlls: number;
+    piletCurrents: number;
+    rules: number;
+  }
+
+  export interface FeedAnalysisDTO {
+    items: Array<{
+      name: string;
+      version: string;
+      spec: string;
+      report: {
+        dependencies: {
+          referenced: Array<{
+            name: string;
+            version: string;
+            distributed: boolean;
+          }>;
+          included: Array<{
+            name: string;
+            version: string;
+            href: string;
+          }>;
+        };
+      };
+    }>;
+  }
+
+  export interface FeedStatisticsDTO {
+    feedRequests: Array<FeedRequestsDTO>;
+    feedUserCountries: Array<FeedUserCountriesDTO>;
+  }
+
+  export interface AdminStatisticsDTO extends ApiPaginatedData<AdminStatisticsItemDTO> {}
+
+  export interface AdminStatisticsDetailsDTO {
+    feedRequests: Array<FeedRequestsDTO>;
+    feedUserCountries: Array<FeedUserCountriesDTO>;
+    feedContributors: number;
+    feedSources: number;
+    feedPilets: AdminStatisticsFeedPiletsDTO;
+  }
+
+  export interface NpmRegistryDTO extends ApiData<NpmItemDTO> {
+    feed: string;
+  }
+
+  export interface NpmPackageDTO {
+    _id: string;
+    name: string;
+    description: string;
+    "dist-tags": Record<string, string>;
+    versions: Record<string, {
+      name: string;
+      description: string;
+      version: string;
+      keywords: Array<string>;
+      readme: string;
+      _from: string;
+      _resolved: string;
+      _integrity: string;
+      _id: string;
+      _nodeVersion: string;
+      _npmVersion: string;
+      dist: {
+        integrity: string;
+        shasum: string;
+        tarball: string;
+      };
+    }>;
+  }
+
+  export interface ApiData<T> {
+    items: Array<T>;
+  }
+
+  export interface ShortFeedDTO extends BaseFeedDTO {
+    contributors: undefined;
+    targetFeeds: undefined;
+    sources: undefined;
+  }
+
+  export interface FullFeedDTO extends BaseFeedDTO {
+    _details: "all";
+    contributors: Array<string>;
+    targetFeeds: Array<string>;
+    sources: Array<{
+      type: string;
+      source: string;
+    }>;
+    domains: Array<string>;
+    invalidDomains: Array<string>;
+    newDomains: Array<string>;
+  }
+
+  export interface PageDTO {
+    feed: string;
+    type: "custom" | "siteless" | "none";
+    version: string;
+    active: boolean;
+  }
+
+  export interface PiletDTO {
+    id: string;
+    name: string;
+    version: string;
+    hash: string;
+    tag: string;
+    selected: boolean;
+    schema: PiletType;
+    canSetTag: boolean;
+    canBundle: boolean;
+    canDelete: boolean;
+  }
+
+  export interface ApiPaginatedData<T> {
+    items: Array<T>;
+    continuation: string;
+  }
+
+  export interface ApiKeyDTO {
+    id: string;
+    name: string;
+    description: string;
+    revoked: boolean;
+    expires: string;
+    scopes: Array<string>;
+    constraints: Array<string>;
+  }
+
+  export interface RuleDTO {
+    id: string;
+    order: number;
+    feed: string;
+    pilet: string;
+    description: string;
+    meta?: string;
+    mode: "allow" | "block";
+    definition: any;
+  }
+
+  export interface ServiceUserDTO {
+    id: string;
+    name: string;
+  }
+
+  export interface FeedContributorDTO {
+    id: string;
+    name: string;
+    verified: boolean;
+    constraints: Array<string>;
+  }
+
+  export interface CustomRuleModuleDTO {
+    file: string;
+    success: boolean;
+    source: "vs" | "fs";
+    rules?: Array<string>;
+    error?: string;
+  }
+
+  export interface FeedRequestsDTO {
+    count: number;
+    from: string;
+    to: string;
+  }
+
+  export interface FeedUserCountriesDTO {
+    name: string;
+    count: number;
+  }
+
+  export interface AdminStatisticsItemDTO {
+    id: string;
+    name: string;
+    owner: string;
+    enabled: boolean;
+    requestsToday: number;
+    requestsLastMonth: number;
+  }
+
+  export interface AdminStatisticsFeedPiletsDTO {
+    current: number;
+    all: number;
+  }
+
+  export interface NpmItemDTO {
+    feed: string;
+    id: string;
+    name: string;
+    version: string;
+    created: string;
+  }
+
+  export interface BaseFeedDTO {
+    id: string;
+    name: string;
+    account: string;
+    description: string;
+    active: boolean;
+    deleted: boolean;
+    integrity: boolean;
+    hook: string;
+    hosts: Array<string>;
+    owner: boolean;
+    canEdit: boolean;
+    canAddUser: boolean;
+    canDelete: boolean;
+    plan: string;
+  }
+
+  export type PiletType = "v0" | "v1" | "v2" | "oc" | "sspa" | "wmf";
+}