@databutton/firebase-types 0.0.1

package/README.md

@@ -0,0 +1,24 @@
+[![Deploy functions to firebase](https://github.com/databutton/databutton-firebase/actions/workflows/deploy-firebase-functions.yml/badge.svg)](https://github.com/databutton/databutton-firebase/actions/workflows/deploy-firebase-functions.yml)
+[![Deploy functions to firebase](https://github.com/databutton/databutton-firebase/actions/workflows/deploy-firebase-functions.yml/badge.svg)](https://github.com/databutton/databutton-firebase/actions/workflows/deploy-firebase-functions.yml)
+
+# Running functions in shell (locally)
+
+*Note:* You need Google Credentials
+
+```bash
+yarn shell
+```
+
+## Execute firebase scripts (for migration etch.)
+
+Set up GOOGLE_APPLICATION_CREDENTIALS from the following guide: <https://firebase.google.com/docs/admin/setup#initialize-sdk> and add the environment variable to the file `<PROJECT_ROOT>/.env`
+
+Modify the `src/run.ts`-file to do what you want.
+
+Execute the script running this command
+
+```bash
+yarn execute
+```
+
+**Note:** This file is added to git with a non-destructive example script and then put into `.gitignore` so it doesn't change elsewhere than locally.

package/lib/types/published/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./persisted";

package/lib/types/published/persisted.d.ts

@@ -0,0 +1,94 @@
+import * as admin from "firebase-admin";
+/**
+ * Types here should reflect data format stored in firestore and
+ * either be backwards-compatible or migrated when needed
+ */
+export interface Profile {
+    displayName: string;
+    email: string;
+    userId?: string;
+    earlyAccess?: boolean;
+    earlyAccessChangedAt?: admin.firestore.Timestamp;
+    enabledFeatures?: string[];
+    admin?: boolean;
+}
+export interface App {
+    name: string;
+    slug: string;
+    createdBy: string;
+    createdAt: admin.firestore.Timestamp;
+    variant: "streamlit";
+    markedForDeletionAt: admin.firestore.Timestamp | null;
+    shortUrl: string;
+}
+export interface Job {
+    name: string;
+    slug: string;
+    createdBy: string;
+    createdAt: admin.firestore.Timestamp;
+    markedForDeletionAt: admin.firestore.Timestamp | null;
+    category: string | null;
+}
+export interface CodeBlock {
+    type: "app" | "job";
+    createdAtUtc: admin.firestore.Timestamp;
+    componentId: string;
+}
+export interface CodeBlockVersion {
+    code: string;
+    createdAtUtc: admin.firestore.Timestamp;
+    version: string;
+    description: string;
+}
+export interface Deployment {
+    createdAt: admin.firestore.Timestamp;
+    createdById: string;
+    createdByName: string;
+    codeBlockId: string;
+    codeBlockVersionId: string;
+    codeRef: string;
+}
+export interface Schedule {
+    createdAt: admin.firestore.Timestamp;
+    updatedAt: admin.firestore.Timestamp;
+    cronExpressionUtc: string;
+    cronExpression: string;
+    cronTimezone: string;
+    state: "ACTIVE" | "PAUSED";
+    id?: string;
+}
+export interface Dataframe {
+    createdAtMillis: number;
+    etag: string;
+    href: string;
+    lastUpdatedAtMillis: number;
+    md5: string;
+    numberOfProperties: number;
+    numberOfRows: number;
+    size: string;
+    sizeInMb: string;
+    markedForDeletionAt?: admin.firestore.Timestamp | null;
+}
+export interface Viewer {
+    userId: string | null;
+    recipient: string;
+    revoked: boolean;
+    createdByUserId: string;
+    createdAtUtc: admin.firestore.Timestamp;
+}
+export interface ShortUrlRef {
+    type: "ref";
+    createdAtUtc: admin.firestore.Timestamp;
+    createdByUserId: string;
+    active: boolean;
+    projectId: string;
+    componentRef: string;
+}
+export interface ShortUrlRedirect {
+    type: "redirect";
+    createdAtUtc: admin.firestore.Timestamp;
+    createdByUserId: string;
+    active: boolean;
+    to: string;
+}
+export declare type ShortUrl = ShortUrlRef | ShortUrlRedirect;

package/lib/types/published/types.d.ts

@@ -0,0 +1,37 @@
+import * as admin from "firebase-admin";
+export interface Project {
+    createdAt: admin.firestore.Timestamp;
+    isPublic: boolean;
+    markedForDeletionAt: admin.firestore.Timestamp | null;
+    members: string[];
+    name: string;
+    owner: string;
+    projectCardColor: string;
+    projectUrl: string;
+    about?: string;
+    githubUrl?: string;
+    isShowcase?: boolean;
+    last_deployed?: admin.firestore.Timestamp;
+    schema?: "2022-08-22" | null;
+    deployIsInProgress?: boolean;
+    deployFinishedAt?: admin.firestore.Timestamp;
+    deployCurrentDeployedId?: string;
+    deployLastDeploymentSuccess?: boolean;
+}
+export interface ProjectInvitation {
+    project: {
+        id: string;
+        name: string;
+    };
+    state: "pending" | "withdrawn" | "accepted" | "cancelled";
+    createdAt: admin.firestore.Timestamp;
+    acceptedAt: admin.firestore.Timestamp | null;
+    role: "member";
+    from: {
+        userId: string;
+        email: string;
+    };
+    to: {
+        email: string;
+    };
+}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@databutton/firebase-types",
+  "version": "0.0.1",
+  "main": "",
+  "types": "lib/types/published/index.d.ts",
+  "files": [
+    "lib/types/published/**/*.d.ts"
+  ],
+  "scripts": {
+    "lint": "eslint --ext .js,.ts .",
+    "prepublish": "tsc",
+    "build": "tsc",
+    "execute": "ts-node functions/run.ts",
+    "serve": "yarn build && firebase emulators:start --only functions",
+    "shell": "yarn build && firebase functions:shell",
+    "start": "yarn shell",
+    "firebase": "firebase",
+    "emulate:firestore": "firebase emulators:start --only firestore --project test",
+    "test:rules": "firebase emulators:exec --only firestore 'jest ./test/firestore-rules'",
+    "test": "jest ./test/firestore-rules",
+    "deploy:rules": "firebase deploy --only firestore:rules",
+    "deploy:functions": "firebase deploy --only functions --debug",
+    "export:config": "firebase functions:config:get > .runtimeconfig.json",
+    "logs": "firebase functions:log",
+    "jest": "jest"
+  },
+  "engines": {
+    "node": "16"
+  },
+  "dependencies": {
+    "@sendgrid/mail": "7.7.0",
+    "@sentry/node": "7.14.0",
+    "@sentry/tracing": "7.14.0",
+    "@slack/web-api": "6.7.2",
+    "analytics-node": "6.2.0",
+    "axios": "0.27.2",
+    "cors": "2.8.5",
+    "firebase-admin": "11.0.1",
+    "firebase-functions": "3.24.0",
+    "intercom-client": "3.1.5",
+    "lodash": "4.17.21",
+    "uuid": "8.3.2"
+  },
+  "devDependencies": {
+    "@firebase/rules-unit-testing": "2.0.4",
+    "@sentry/types": "7.14.0",
+    "@types/analytics-node": "3.1.9",
+    "@types/jest": "29.0.3",
+    "@types/lodash": "4.14.186",
+    "@types/node": "18.7.14",
+    "@types/uuid": "8.3.4",
+    "@typescript-eslint/eslint-plugin": "5.38.1",
+    "@typescript-eslint/parser": "5.38.1",
+    "dotenv": "16.0.3",
+    "eslint": "8.24.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-config-google": "0.14.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-jest": "27.0.4",
+    "firebase": "9.10.0",
+    "firebase-functions-test": "2.4.0",
+    "firebase-tools": "11.10.0",
+    "jest": "28.1.3",
+    "ts-jest": "28.0.8",
+    "ts-node": "10.9.1",
+    "typescript": "4.8.4"
+  }
+}