solid-ui 2.4.16-29d82bfe → 2.4.16-520c493e

package/lib/authn/authn.d.ts

@@ -0,0 +1,193 @@
+/**
+ * Signing in, signing up, profile and preferences reloading
+ * Type index management
+ *
+ * Many functions in this module take a context object which
+ * holds various RDF symbols, add to it, and return a promise of it.
+ *
+ * * `me`                RDF symbol for the user's WebID
+ * * `publicProfile`     The user's public profile, iff loaded
+ * * `preferencesFile`   The user's personal preference file, iff loaded
+ * * `index.public`      The user's public type index file
+ * * `index.private`     The user's private type index file
+ *
+ * Not RDF symbols:
+ * * `noun`            A string in english for the type of thing -- like "address book"
+ * * `instance`        An array of nodes which are existing instances
+ * * `containers`      An array of nodes of containers of instances
+ * * `div`             A DOM element where UI can be displayed
+ * * `statusArea`      A DOM element (opt) progress stuff can be displayed, or error messages
+ * @packageDocumentation
+ */
+import { NamedNode } from 'rdflib';
+import { PaneDefinition } from 'pane-registry';
+import { AppDetails, AuthenticationContext } from './types';
+export declare const authSession: import("@inrupt/solid-client-authn-browser").Session;
+/**
+ * Look for and load the User who has control over it
+ */
+export declare function findOriginOwner(doc: NamedNode | string): string | boolean;
+/**
+ * Saves `webId` in `context.me`
+ * @param webId
+ * @param context
+ *
+ * @returns Returns the WebID, after setting it
+ */
+export declare function saveUser(webId: NamedNode | string | null, context?: AuthenticationContext): NamedNode | null;
+/**
+ * Wrapper around [[offlineTestID]]
+ * @returns {NamedNode|null}
+ */
+export declare function defaultTestUser(): NamedNode | null;
+/**
+ * Checks synchronously whether user is logged in
+ *
+ * @returns Named Node or null
+ */
+export declare function currentUser(): NamedNode | null;
+/**
+ * Resolves with the logged in user's WebID
+ *
+ * @param context
+ */
+export declare function logIn(context: AuthenticationContext): Promise<AuthenticationContext>;
+/**
+ * Logs the user in and loads their WebID profile document into the store
+ *
+ * @param context
+ *
+ * @returns Resolves with the context after login / fetch
+ */
+export declare function logInLoadProfile(context: AuthenticationContext): Promise<AuthenticationContext>;
+/**
+ * Loads preference file
+ * Do this after having done log in and load profile
+ *
+ * @private
+ *
+ * @param context
+ */
+export declare function logInLoadPreferences(context: AuthenticationContext): Promise<AuthenticationContext>;
+export declare function loadTypeIndexes(context: AuthenticationContext): Promise<AuthenticationContext>;
+/**
+ * Returns promise of context with arrays of symbols
+ *
+ * 2016-12-11 change to include forClass arc a la
+ * https://github.com/solid/solid/blob/main/proposals/data-discovery.md
+ */
+export declare function findAppInstances(context: AuthenticationContext, theClass: NamedNode, isPublic?: boolean): Promise<AuthenticationContext>;
+/**
+ * Register a new app in a type index
+ */
+export declare function registerInTypeIndex(context: AuthenticationContext, instance: NamedNode, theClass: NamedNode, isPublic: boolean): Promise<AuthenticationContext>;
+/**
+ * UI to control registration of instance
+ */
+export declare function registrationControl(context: AuthenticationContext, instance: any, theClass: any): Promise<AuthenticationContext | void>;
+/**
+ * UI to List at all registered things
+ */
+export declare function registrationList(context: AuthenticationContext, options: {
+    private?: boolean;
+    public?: boolean;
+    type?: NamedNode;
+}): Promise<AuthenticationContext>;
+/**
+ * Simple Access Control
+ *
+ * This function sets up a simple default ACL for a resource, with
+ * RWC for the owner, and a specified access (default none) for the public.
+ * In all cases owner has read write control.
+ * Parameter lists modes allowed to public
+ *
+ * @param options
+ * @param options.public eg ['Read', 'Write']
+ *
+ * @returns Resolves with aclDoc uri on successful write
+ */
+export declare function setACLUserPublic(docURI: string, me: NamedNode, options: {
+    defaultForNew?: boolean;
+    public?: [];
+}): Promise<NamedNode>;
+/**
+ * Returns `sym($SolidTestEnvironment.username)` if
+ * `$SolidTestEnvironment.username` is defined as a global
+ * @returns {NamedNode|null}
+ */
+export declare function offlineTestID(): NamedNode | null;
+export declare function renderSignInPopup(dom: HTMLDocument): void;
+/**
+ * @returns {Promise<string|null>} Resolves with WebID URI or null
+ */
+/**
+ * Retrieves currently logged in webId from either
+ * defaultTestUser or SolidAuth
+ * @param [setUserCallback] Optional callback
+ *
+ * @returns Resolves with webId uri, if no callback provided
+ */
+export declare function checkUser<T>(setUserCallback?: (me: NamedNode | null) => T): Promise<NamedNode | T | null>;
+/**
+ * Login status box
+ *
+ * A big sign-up/sign in box or a logout box depending on the state
+ *
+ * @param dom
+ * @param listener
+ *
+ * @returns
+ */
+export declare function loginStatusBox(dom: HTMLDocument, listener?: ((uri: string | null) => void) | null, options?: {
+    buttonStyle?: string;
+}): HTMLElement;
+/**
+ * Workspace selection etc
+ * See https://github.com/solid/userguide/issues/16
+ */
+/**
+ * Returns a UI object which, if it selects a workspace,
+ * will callback(workspace, newBase).
+ * See https://github.com/solid/userguide/issues/16 for more info on workspaces.
+ *
+ * If necessary, will get an account, preference file, etc. In sequence:
+ *
+ *   - If not logged in, log in.
+ *   - Load preference file
+ *   - Prompt user for workspaces
+ *   - Allows the user to just type in a URI by hand
+ *
+ * Calls back with the workspace and the base URI
+ *
+ * @param dom
+ * @param appDetails
+ * @param callbackWS
+ */
+export declare function selectWorkspace(dom: HTMLDocument, appDetails: AppDetails, callbackWS: (workspace: string | null, newBase: string) => void): HTMLElement;
+/**
+ * Creates a new instance of an app.
+ *
+ * An instance of an app could be e.g. an issue tracker for a given project,
+ * or a chess game, or calendar, or a health/fitness record for a person.
+ *
+ * Note that this use of the term 'app' refers more to entries in the user's
+ * type index than to actual software applications that use the personal data
+ * to which these entries point.
+ *
+ * @param dom
+ * @param appDetails
+ * @param callback
+ *
+ * @returns A div with a button in it for making a new app instance
+ */
+export declare function newAppInstance(dom: HTMLDocument, appDetails: AppDetails, callback: (workspace: string | null, newBase: string) => void): HTMLElement;
+/**
+ * Retrieves whether the currently logged in user is a power user
+ * and/or a developer
+ */
+export declare function getUserRoles(): Promise<Array<NamedNode>>;
+/**
+ * Filters which panes should be available, based on the result of [[getUserRoles]]
+ */
+export declare function filterAvailablePanes(panes: Array<PaneDefinition>): Promise<Array<PaneDefinition>>;
+//# sourceMappingURL=authn.d.ts.map

package/lib/authn/authn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authn.d.ts","sourceRoot":"","sources":["../../src/authn/authn.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAAoB,SAAS,EAAuD,MAAM,QAAQ,CAAA;AACzG,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAO9C,OAAO,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAU3D,eAAO,MAAM,WAAW,sDAAoB,CAAA;AAuB5C;;GAEG;AACH,wBAAgB,eAAe,CAAE,GAAG,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAQ1E;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,IAAI,EAChC,OAAO,CAAC,EAAE,qBAAqB,GAC9B,SAAS,GAAG,IAAI,CAYlB;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAK,SAAS,GAAG,IAAI,CASnD;AA+BD;;;;GAIG;AACH,wBAAgB,WAAW,IAAK,SAAS,GAAG,IAAI,CAU/C;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CA2BrF;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAoBtG;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CA4D1G;AAwBD,wBAAsB,eAAe,CAAE,OAAO,EAAE,qBAAqB,kCAWpE;AAuFD;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,qBAAqB,EAC9B,QAAQ,EAAE,SAAS,EACnB,QAAQ,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,qBAAqB,CAAC,CAoEhC;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,qBAAqB,EAC9B,QAAQ,EAAE,SAAS,EACnB,QAAQ,EAAE,SAAS,EACnB,QAAQ,EAAE,OAAO,GAChB,OAAO,CAAC,qBAAqB,CAAC,CAwBhC;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,qBAAqB,EAC9B,QAAQ,KAAA,EACR,QAAQ,KAAA,GACP,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAgFvC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAE,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE;IACzE,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAoEjC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,SAAS,EACb,OAAO,EAAE;IACP,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,EAAE,CAAA;CACZ,GACA,OAAO,CAAC,SAAS,CAAC,CAkCpB;AA2ED;;;;GAIG;AACH,wBAAgB,aAAa,IAAK,SAAS,GAAG,IAAI,CA0BjD;AA2FD,wBAAgB,iBAAiB,CAAE,GAAG,EAAE,YAAY,QAoHnD;AAmCD;;GAEG;AAQH;;;;;;GAMG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAC/B,eAAe,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,GAAG,IAAI,KAAK,CAAC,GAC5C,OAAO,CAAC,SAAS,GAAG,CAAC,GAAG,IAAI,CAAC,CAsD/B;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,GAAG,EAAE,YAAY,EACjB,QAAQ,GAAE,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC,GAAG,IAAW,EACtD,OAAO,GAAE;IACP,WAAW,CAAC,EAAE,MAAM,CAAA;CAChB,GACL,WAAW,CA4Fb;AAsBD;;;GAGG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,YAAY,EACjB,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,GAC9D,WAAW,CAqNb;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,cAAc,CAC5B,GAAG,EAAE,YAAY,EACjB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,GAC5D,WAAW,CAeb;AAED;;;GAGG;AACH,wBAAsB,YAAY,IAAK,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAe/D;AAED;;GAEG;AACH,wBAAsB,oBAAoB,CAAE,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAGxG"}