create-flink-app 0.12.1-alpha.6 → 0.12.1-alpha.7

package/dist/default/gitignore

@@ -0,0 +1,37 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/*/**/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# VSCode
+.vscode
+
+# Generated schemas etc
+/.flink
+
+# Generated bundle
+/dist

package/dist/default/nodemon.json

@@ -0,0 +1,7 @@
+{
+  "watch": ["src", "spec"],
+  "ext": "ts,json",
+  "watchOptions": {
+    "followSymlinks": false
+  }
+}

package/dist/default/spec/Pet.spec.ts

@@ -0,0 +1,44 @@
+import { FlinkApp } from "@flink-app/flink";
+import * as testUtils from "@flink-app/test-utils";
+import { Ctx } from "../src/Ctx";
+import { Pet } from "../src/schemas/Pet";
+
+describe("Pet", () => {
+    let flinkApp: FlinkApp<Ctx>;
+
+    beforeAll(async () => {
+        flinkApp = new FlinkApp({
+            name: "Test",
+            db: {
+                uri: "mongodb://localhost:27017/my-flink-app-test",
+            },
+        });
+
+        testUtils.init(await flinkApp.start());
+    });
+
+    describe("get pet", () => {
+        let aPet: Pet;
+
+        beforeAll(async () => {
+            aPet = await flinkApp.ctx.repos.petRepo.create({
+                age: 12,
+                created: new Date(),
+                name: "Buster",
+            });
+        });
+
+        it("should get 404", async () => {
+            const nonExistingPetId = "5349b4ddd2781d08c09890f3";
+            const { status } = await testUtils.get(`/pet/${nonExistingPetId}`);
+            expect(status).toBe(404);
+        });
+
+        it("should get pet", async () => {
+            const { status, data } = await testUtils.get<Pet>(`/pet/${aPet._id}`);
+            expect(status).toBe(200);
+            expect(data!._id).toEqual(aPet._id);
+            expect(new Date(data!.created)).toEqual(aPet.created);
+        });
+    });
+});

package/dist/default/spec/support/jasmine.json

@@ -0,0 +1,7 @@
+{
+  "spec_dir": "dist/spec",
+  "spec_files": ["**/*[sS]pec.js"],
+  "helpers": ["helpers/**/*.js"],
+  "stopSpecOnExpectationFailure": false,
+  "random": true
+}

package/dist/default/spec/support/runner.ts

@@ -0,0 +1,32 @@
+import Jasmine from "jasmine";
+import {
+  DisplayProcessor,
+  SpecReporter,
+  StacktraceOption,
+} from "jasmine-spec-reporter";
+import SuiteInfo = jasmine.SuiteInfo;
+
+const jasmine = new Jasmine({});
+
+jasmine.loadConfigFile("spec/support/jasmine.json");
+jasmine.configureDefaultReporter({
+  showColors: false,
+});
+
+class CustomProcessor extends DisplayProcessor {
+  public displayJasmineStarted(info: SuiteInfo, log: string): string {
+    return `TypeScript ${log}`;
+  }
+}
+
+jasmine.clearReporters();
+jasmine.addReporter(
+  new SpecReporter({
+    spec: {
+      displayStacktrace: StacktraceOption.NONE,
+    },
+    customProcessors: [CustomProcessor],
+  })
+);
+
+jasmine.execute();

package/dist/default/src/Ctx.ts

@@ -0,0 +1,11 @@
+import { FlinkContext } from "@flink-app/flink";
+import PetRepo from "./repos/PetRepo";
+
+// Pass any plugin types as generic argument
+// Example: FlinkContext<ApiDocsPlugin & FirbasePlugin>
+
+export interface Ctx extends FlinkContext {
+  repos: {
+    petRepo: PetRepo;
+  };
+}

package/dist/default/src/handlers/GetPet.ts

@@ -0,0 +1,28 @@
+import { GetHandler, notFound, RouteProps } from "@flink-app/flink";
+import { Ctx } from "../Ctx";
+import { Pet } from "../schemas/Pet";
+
+export const Route: RouteProps = {
+  path: "/pet/:id",
+};
+
+type Params = {
+  id: string;
+};
+
+const GetPet: GetHandler<Ctx, Pet, Params> = async ({ ctx, req }) => {
+  const { id } = req.params;
+  const { petRepo } = ctx.repos;
+
+  const pet = await petRepo.getById(id);
+
+  if (!pet) {
+    return notFound(`Pet with id ${id} could not be found`);
+  }
+
+  return {
+    data: pet,
+  };
+};
+
+export default GetPet;

package/dist/default/src/handlers/PostPet.ts

@@ -0,0 +1,19 @@
+import { Handler, notFound, RouteProps } from "@flink-app/flink";
+import { Ctx } from "../Ctx";
+import { Pet } from "../schemas/Pet";
+import { PostPetReq } from "../schemas/PostPetReq";
+
+export const Route: RouteProps = {
+  path: "/pet",
+};
+
+const PostPet: Handler<Ctx, PostPetReq, Pet> = async ({ ctx, req }) => {
+  const { petRepo } = ctx.repos;
+  const pet = await petRepo.create({ ...req.body, created: new Date() });
+
+  return {
+    data: pet,
+  };
+};
+
+export default PostPet;

package/dist/default/src/index.ts

@@ -0,0 +1,17 @@
+import { FlinkApp } from "@flink-app/flink";
+import { Ctx } from "./Ctx";
+
+function start() {
+  new FlinkApp<Ctx>({
+    name: "My flink app",
+    debug: true,
+    db: {
+      uri: "mongodb://localhost:27017/my-flink-app",
+    },
+    plugins: [
+      // Add any plugins here
+    ],
+  }).start();
+}
+
+start();

package/dist/default/src/repos/PetRepo.ts

@@ -0,0 +1,7 @@
+import { FlinkRepo } from "@flink-app/flink";
+import { Ctx } from "../Ctx";
+import { Pet } from "../schemas/Pet";
+
+class PetRepo extends FlinkRepo<Ctx, Pet> {}
+
+export default PetRepo;

package/dist/default/src/schemas/Pet.ts

@@ -0,0 +1,21 @@
+export interface Pet {
+  /**
+   * Id of pet, is generated by db
+   */
+  _id: string;
+
+  /**
+   * Name of pet, i.e "Bob the dog"
+   */
+  name: string;
+
+  /**
+   * Age in years
+   */
+  age: number;
+
+  /**
+   * Date when pet was created
+   */
+  created: Date;
+}

package/dist/default/src/schemas/PostPetReq.ts

@@ -0,0 +1,7 @@
+import { Pet } from "./Pet";
+
+/**
+ * Creates new Pet.
+ * Will set `_id` and `created` timestamp after created.
+ */
+export interface PostPetReq extends Omit<Pet, "_id" | "created"> {}

package/dist/default/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["esnext", "es2016"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "experimentalDecorators": true,
+    "checkJs": true
+  },
+  "include": ["./src/**/*.ts", "./spec/**/*"],
+  "exclude": ["./node_modules/*"]
+}