@pyric/cli 0.1.0-alpha.19 → 0.1.0-alpha.20

package/dist/serve/site-ui/docs/pyric-admin-reference-api.md

@@ -0,0 +1,587 @@
+<!-- Generated from published package declarations via TypeDoc. Rendered by the api-reference content loader. -->
+
+## Variables
+
+<a id="auth"></a>
+
+### auth()
+
+```ts
+const auth: (app?: PyricAdminApp) => Auth;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`PyricAdminApp`](pyric-admin-app-reference-api.md#pyricadminapp) |
+
+#### Returns
+
+[`Auth`](pyric-admin-auth-reference-api.md#auth)
+
+***
+
+<a id="credential"></a>
+
+### credential
+
+```ts
+const credential: {
+  applicationDefault: typeof applicationDefault;
+  cert: typeof cert;
+  refreshToken: (token: string) => {
+   [x: symbol]: string;
+     token: string;
+  };
+};
+```
+
+#### Type Declaration
+
+<a id="applicationdefault"></a>
+
+##### applicationDefault
+
+```ts
+applicationDefault: typeof applicationDefault;
+```
+
+<a id="cert"></a>
+
+##### cert
+
+```ts
+cert: typeof cert;
+```
+
+<a id="refreshtoken"></a>
+
+##### refreshToken()
+
+```ts
+refreshToken: (token: string) => {
+[x: symbol]: string;
+  token: string;
+};
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `token` | `string` |
+
+###### Returns
+
+```ts
+{
+[x: symbol]: string;
+  token: string;
+}
+```
+
+###### token
+
+```ts
+token: string;
+```
+
+***
+
+<a id="database"></a>
+
+### database()
+
+```ts
+const database: (app?: PyricAdminApp) => Database;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`PyricAdminApp`](pyric-admin-app-reference-api.md#pyricadminapp) |
+
+#### Returns
+
+[`Database`](pyric-admin-database-reference-api.md#database)
+
+***
+
+<a id="default"></a>
+
+### default
+
+```ts
+const default: {
+  ADMIN_APP_TARGET: typeof ADMIN_APP_TARGET;
+  auth: (app?: PyricAdminApp) => Auth;
+  credential: {
+     applicationDefault: typeof applicationDefault;
+     cert: typeof cert;
+     refreshToken: (token: string) => {
+      [x: symbol]: string;
+        token: string;
+     };
+  };
+  database: (app?: PyricAdminApp) => Database;
+  DEFAULT_APP_NAME: "[DEFAULT]";
+  firestore: (app?: PyricAdminApp) => SandboxFirestore;
+  messaging: (app?: PyricAdminApp) => Messaging;
+  storage: (app?: PyricAdminApp) => Storage;
+  applicationDefault: never;
+  cert: object;
+  deleteApp: Promise<void>;
+  getApp: SandboxAdminApp;
+  getApps: SandboxAdminApp[];
+  initializeApp: SandboxAdminApp;
+  isSandboxAdminApp: app is SandboxAdminApp;
+};
+```
+
+#### Type Declaration
+
+<a id="admin_app_target"></a>
+
+##### ADMIN\_APP\_TARGET
+
+```ts
+ADMIN_APP_TARGET: typeof ADMIN_APP_TARGET;
+```
+
+<a id="auth-1"></a>
+
+##### auth()
+
+```ts
+auth: (app?: PyricAdminApp) => Auth;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`PyricAdminApp`](pyric-admin-app-reference-api.md#pyricadminapp) |
+
+###### Returns
+
+[`Auth`](pyric-admin-auth-reference-api.md#auth)
+
+<a id="credential-1"></a>
+
+##### credential
+
+```ts
+credential: {
+  applicationDefault: typeof applicationDefault;
+  cert: typeof cert;
+  refreshToken: (token: string) => {
+   [x: symbol]: string;
+     token: string;
+  };
+};
+```
+
+###### credential.applicationDefault
+
+```ts
+applicationDefault: typeof applicationDefault;
+```
+
+###### credential.cert
+
+```ts
+cert: typeof cert;
+```
+
+###### credential.refreshToken()
+
+```ts
+refreshToken: (token: string) => {
+[x: symbol]: string;
+  token: string;
+};
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `token` | `string` |
+
+###### Returns
+
+```ts
+{
+[x: symbol]: string;
+  token: string;
+}
+```
+
+###### token
+
+```ts
+token: string;
+```
+
+<a id="database-1"></a>
+
+##### database()
+
+```ts
+database: (app?: PyricAdminApp) => Database;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`PyricAdminApp`](pyric-admin-app-reference-api.md#pyricadminapp) |
+
+###### Returns
+
+[`Database`](pyric-admin-database-reference-api.md#database)
+
+<a id="default_app_name"></a>
+
+##### DEFAULT\_APP\_NAME
+
+```ts
+DEFAULT_APP_NAME: "[DEFAULT]";
+```
+
+<a id="firestore"></a>
+
+##### firestore()
+
+```ts
+firestore: (app?: PyricAdminApp) => SandboxFirestore;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`PyricAdminApp`](pyric-admin-app-reference-api.md#pyricadminapp) |
+
+###### Returns
+
+[`SandboxFirestore`](pyric-admin-firestore-reference-api.md#sandboxfirestore)
+
+<a id="messaging"></a>
+
+##### messaging()
+
+```ts
+messaging: (app?: PyricAdminApp) => Messaging;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`PyricAdminApp`](pyric-admin-app-reference-api.md#pyricadminapp) |
+
+###### Returns
+
+[`Messaging`](pyric-admin-messaging-reference-api.md#messaging)
+
+<a id="storage"></a>
+
+##### storage()
+
+```ts
+storage: (app?: PyricAdminApp) => Storage;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`PyricAdminApp`](pyric-admin-app-reference-api.md#pyricadminapp) |
+
+###### Returns
+
+[`Storage`](pyric-admin-storage-reference-api.md#storage)
+
+<a id="applicationdefault-1"></a>
+
+##### applicationDefault()
+
+```ts
+applicationDefault(): never;
+```
+
+###### Returns
+
+`never`
+
+<a id="cert-1"></a>
+
+##### cert()
+
+```ts
+cert(serviceAccountPathOrObject: unknown): object;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `serviceAccountPathOrObject` | `unknown` |
+
+###### Returns
+
+`object`
+
+<a id="deleteapp"></a>
+
+##### deleteApp()
+
+```ts
+deleteApp(app: SandboxAdminApp): Promise<void>;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app` | [`SandboxAdminApp`](pyric-admin-app-reference-api.md#sandboxadminapp) |
+
+###### Returns
+
+`Promise`\<`void`\>
+
+<a id="getapp"></a>
+
+##### getApp()
+
+```ts
+getApp(name?: string): SandboxAdminApp;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `name?` | `string` |
+
+###### Returns
+
+[`SandboxAdminApp`](pyric-admin-app-reference-api.md#sandboxadminapp)
+
+<a id="getapps"></a>
+
+##### getApps()
+
+```ts
+getApps(): SandboxAdminApp[];
+```
+
+###### Returns
+
+[`SandboxAdminApp`](pyric-admin-app-reference-api.md#sandboxadminapp)[]
+
+<a id="initializeapp"></a>
+
+##### initializeApp()
+
+```ts
+initializeApp(config?:
+  | Record<string, unknown>
+  | InitializeAdminAppConfig, name?: string): SandboxAdminApp;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `config?` | \| `Record`\<`string`, `unknown`\> \| [`InitializeAdminAppConfig`](pyric-admin-app-reference-api.md#initializeadminappconfig) |
+| `name?` | `string` |
+
+###### Returns
+
+[`SandboxAdminApp`](pyric-admin-app-reference-api.md#sandboxadminapp)
+
+<a id="issandboxadminapp"></a>
+
+##### isSandboxAdminApp()
+
+```ts
+isSandboxAdminApp(app: SandboxAdminApp): app is SandboxAdminApp;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app` | [`SandboxAdminApp`](pyric-admin-app-reference-api.md#sandboxadminapp) |
+
+###### Returns
+
+`app is SandboxAdminApp`
+
+***
+
+<a id="firestore-1"></a>
+
+### firestore()
+
+```ts
+const firestore: (app?: PyricAdminApp) => SandboxFirestore;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`PyricAdminApp`](pyric-admin-app-reference-api.md#pyricadminapp) |
+
+#### Returns
+
+[`SandboxFirestore`](pyric-admin-firestore-reference-api.md#sandboxfirestore)
+
+***
+
+<a id="messaging-1"></a>
+
+### messaging()
+
+```ts
+const messaging: (app?: PyricAdminApp) => Messaging;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`PyricAdminApp`](pyric-admin-app-reference-api.md#pyricadminapp) |
+
+#### Returns
+
+[`Messaging`](pyric-admin-messaging-reference-api.md#messaging)
+
+***
+
+<a id="storage-1"></a>
+
+### storage()
+
+```ts
+const storage: (app?: PyricAdminApp) => Storage;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `app?` | [`PyricAdminApp`](pyric-admin-app-reference-api.md#pyricadminapp) |
+
+#### Returns
+
+[`Storage`](pyric-admin-storage-reference-api.md#storage)
+
+## References
+
+<a id="admin_app_target-1"></a>
+
+### ADMIN\_APP\_TARGET
+
+Re-exports [ADMIN_APP_TARGET](pyric-admin-app-reference-api.md#admin_app_target-1)
+
+***
+
+<a id="applicationdefault-3"></a>
+
+### applicationDefault
+
+Re-exports [applicationDefault](pyric-admin-app-reference-api.md#applicationdefault)
+
+***
+
+<a id="cert-3"></a>
+
+### cert
+
+Re-exports [cert](pyric-admin-app-reference-api.md#cert)
+
+***
+
+<a id="default_app_name-1"></a>
+
+### DEFAULT\_APP\_NAME
+
+Re-exports [DEFAULT_APP_NAME](pyric-admin-app-reference-api.md#default_app_name)
+
+***
+
+<a id="deleteapp-2"></a>
+
+### deleteApp
+
+Re-exports [deleteApp](pyric-admin-app-reference-api.md#deleteapp)
+
+***
+
+<a id="getapp-2"></a>
+
+### getApp
+
+Re-exports [getApp](pyric-admin-app-reference-api.md#getapp)
+
+***
+
+<a id="getapps-2"></a>
+
+### getApps
+
+Re-exports [getApps](pyric-admin-app-reference-api.md#getapps)
+
+***
+
+<a id="initializeadminappconfig"></a>
+
+### InitializeAdminAppConfig
+
+Re-exports [InitializeAdminAppConfig](pyric-admin-app-reference-api.md#initializeadminappconfig)
+
+***
+
+<a id="initializeapp-2"></a>
+
+### initializeApp
+
+Re-exports [initializeApp](pyric-admin-app-reference-api.md#initializeapp)
+
+***
+
+<a id="issandboxadminapp-2"></a>
+
+### isSandboxAdminApp
+
+Re-exports [isSandboxAdminApp](pyric-admin-app-reference-api.md#issandboxadminapp)
+
+***
+
+<a id="pyricadminapp"></a>
+
+### PyricAdminApp
+
+Re-exports [PyricAdminApp](pyric-admin-app-reference-api.md#pyricadminapp)
+
+***
+
+<a id="pyricadminapptarget"></a>
+
+### PyricAdminAppTarget
+
+Re-exports [PyricAdminAppTarget](pyric-admin-app-reference-api.md#pyricadminapptarget)
+
+***
+
+<a id="sandboxadminapp"></a>
+
+### SandboxAdminApp
+
+Re-exports [SandboxAdminApp](pyric-admin-app-reference-api.md#sandboxadminapp)