@flarequery/firebase 0.1.0 → 0.1.2

package/dist/index.d.cts

@@ -1,37 +1,70 @@
+import { QueryContext, FlareResponse, FlareCollectionResponse, ModelDefinition } from '@flarequery/core';
+export { AuthRule, FieldDefinition, FlareResponse, ModelDefinition, QueryContext, RelationDefinition } from '@flarequery/core';
 import { Auth } from 'firebase-admin/auth';
 import { Firestore } from 'firebase-admin/firestore';
 import * as firebase_functions_v2_https from 'firebase-functions/v2/https';
 import * as functionsV1 from 'firebase-functions/v1';
 
-type RelationType = "one" | "many";
-interface RelationDefinition {
-    from: string;
-    to: string;
-    type: RelationType;
-}
-type ScalarType = "string" | "number" | "boolean" | "timestamp";
-interface RelationFieldDefinition {
-    relation: RelationDefinition;
-    select?: string[];
-}
-type FieldDefinition = ScalarType | RelationFieldDefinition;
-interface ModelDefinition {
-    source: FirestoreCollectionRef;
-    fields: Record<string, FieldDefinition>;
-    auth?: AuthRule;
-}
-type AuthRule = (ctx: QueryContext) => boolean;
-interface QueryContext {
-    userId: string | null;
-    token: Record<string, unknown> | null;
-}
-interface FirestoreCollectionRef {
-    readonly path: string;
-}
-type FlareResult = Record<string, unknown>;
-interface FlareResponse {
-    data: FlareResult | null;
-    errors?: string[];
+interface CollectionReference {
+    /**
+     * Fetch a single document by ID.
+     * @example app.collection("Product").doc("abc123")
+     */
+    doc(id: string): DocumentReference;
+    /**
+     * Start a collection query with a filter.
+     * @example app.collection("Product").filter("oem").equals("Canon")
+     */
+    filter(field: string): FilterBuilder;
+}
+interface DocumentReference {
+    /**
+     * Select specific fields to fetch. Use dot notation for relations.
+     * @example .select("name", "price", "participants.name")
+     */
+    select(...fields: string[]): Query;
+}
+interface Query {
+    get(ctx: QueryContext): Promise<FlareResponse>;
+}
+/**
+ * FilterBuilder — returned by .filter("fieldName")
+ * @example
+ *   .filter("oem").equals("Canon")
+ *   .filter("price").gte(100)
+ *   .filter("price").gte(100).lte(500)
+ *   .filter("status").in(["New", "Clearout"])
+ *   .filter("tags").contains("laser")
+ *   .filter("status").not("Discontinued")
+ */
+interface FilterBuilder {
+    equals(value: string | number | boolean): CollectionQuery;
+    not(value: string | number | boolean): CollectionQuery;
+    gt(value: number | string): CollectionQuery;
+    gte(value: number | string): CollectionQuery;
+    lt(value: number | string): CollectionQuery;
+    lte(value: number | string): CollectionQuery;
+    in(values: (string | number)[]): CollectionQuery;
+    contains(value: string | number): CollectionQuery;
+}
+/**
+ * CollectionQuery — the chainable query builder.
+ * @example
+ *   app.collection("Product")
+ *     .filter("oem").equals("Canon")
+ *     .filter("isActive").equals(true)
+ *     .filter("price").gte(50)
+ *     .select("name", "price", "rtsPN")
+ *     .orderBy("name", "asc")
+ *     .limit(50)
+ *     .get(ctx)
+ */
+interface CollectionQuery {
+    filter(field: string): FilterBuilder;
+    select(...fields: string[]): CollectionQuery;
+    orderBy(field: string, direction: "asc" | "desc"): CollectionQuery;
+    limit(n: number): CollectionQuery;
+    get(ctx: QueryContext): Promise<FlareCollectionResponse>;
 }
 
 interface ServerlessAppOptions {
@@ -40,9 +73,10 @@ interface ServerlessAppOptions {
 }
 interface ServerlessApp {
     model(name: string, definition: ModelDefinition): void;
-    execute(query: string, ctx: QueryContext): Promise<FlareResponse>;
+    collection(name: string): CollectionReference;
 }
 declare function createServerlessApp(options: ServerlessAppOptions): ServerlessApp;
+declare function extractContext(authorization: string | undefined, auth: Auth): Promise<QueryContext>;
 
 interface FunctionOptions {
     cors?: boolean;
@@ -50,4 +84,4 @@ interface FunctionOptions {
 declare function createFunction(app: ServerlessApp, auth: Auth, options?: FunctionOptions): functionsV1.HttpsFunction;
 declare function createOnRequest(app: ServerlessApp, auth: Auth, options?: FunctionOptions): firebase_functions_v2_https.HttpsFunction;
 
-export { type AuthRule, type FieldDefinition, type FlareResponse, type ModelDefinition, type QueryContext, type RelationDefinition, createFunction, createOnRequest, createServerlessApp };
+export { type CollectionReference, type DocumentReference, type FunctionOptions, type Query, type ServerlessApp, type ServerlessAppOptions, createFunction, createOnRequest, createServerlessApp, extractContext };

package/dist/index.d.ts

@@ -1,37 +1,70 @@
+import { QueryContext, FlareResponse, FlareCollectionResponse, ModelDefinition } from '@flarequery/core';
+export { AuthRule, FieldDefinition, FlareResponse, ModelDefinition, QueryContext, RelationDefinition } from '@flarequery/core';
 import { Auth } from 'firebase-admin/auth';
 import { Firestore } from 'firebase-admin/firestore';
 import * as firebase_functions_v2_https from 'firebase-functions/v2/https';
 import * as functionsV1 from 'firebase-functions/v1';
 
-type RelationType = "one" | "many";
-interface RelationDefinition {
-    from: string;
-    to: string;
-    type: RelationType;
-}
-type ScalarType = "string" | "number" | "boolean" | "timestamp";
-interface RelationFieldDefinition {
-    relation: RelationDefinition;
-    select?: string[];
-}
-type FieldDefinition = ScalarType | RelationFieldDefinition;
-interface ModelDefinition {
-    source: FirestoreCollectionRef;
-    fields: Record<string, FieldDefinition>;
-    auth?: AuthRule;
-}
-type AuthRule = (ctx: QueryContext) => boolean;
-interface QueryContext {
-    userId: string | null;
-    token: Record<string, unknown> | null;
-}
-interface FirestoreCollectionRef {
-    readonly path: string;
-}
-type FlareResult = Record<string, unknown>;
-interface FlareResponse {
-    data: FlareResult | null;
-    errors?: string[];
+interface CollectionReference {
+    /**
+     * Fetch a single document by ID.
+     * @example app.collection("Product").doc("abc123")
+     */
+    doc(id: string): DocumentReference;
+    /**
+     * Start a collection query with a filter.
+     * @example app.collection("Product").filter("oem").equals("Canon")
+     */
+    filter(field: string): FilterBuilder;
+}
+interface DocumentReference {
+    /**
+     * Select specific fields to fetch. Use dot notation for relations.
+     * @example .select("name", "price", "participants.name")
+     */
+    select(...fields: string[]): Query;
+}
+interface Query {
+    get(ctx: QueryContext): Promise<FlareResponse>;
+}
+/**
+ * FilterBuilder — returned by .filter("fieldName")
+ * @example
+ *   .filter("oem").equals("Canon")
+ *   .filter("price").gte(100)
+ *   .filter("price").gte(100).lte(500)
+ *   .filter("status").in(["New", "Clearout"])
+ *   .filter("tags").contains("laser")
+ *   .filter("status").not("Discontinued")
+ */
+interface FilterBuilder {
+    equals(value: string | number | boolean): CollectionQuery;
+    not(value: string | number | boolean): CollectionQuery;
+    gt(value: number | string): CollectionQuery;
+    gte(value: number | string): CollectionQuery;
+    lt(value: number | string): CollectionQuery;
+    lte(value: number | string): CollectionQuery;
+    in(values: (string | number)[]): CollectionQuery;
+    contains(value: string | number): CollectionQuery;
+}
+/**
+ * CollectionQuery — the chainable query builder.
+ * @example
+ *   app.collection("Product")
+ *     .filter("oem").equals("Canon")
+ *     .filter("isActive").equals(true)
+ *     .filter("price").gte(50)
+ *     .select("name", "price", "rtsPN")
+ *     .orderBy("name", "asc")
+ *     .limit(50)
+ *     .get(ctx)
+ */
+interface CollectionQuery {
+    filter(field: string): FilterBuilder;
+    select(...fields: string[]): CollectionQuery;
+    orderBy(field: string, direction: "asc" | "desc"): CollectionQuery;
+    limit(n: number): CollectionQuery;
+    get(ctx: QueryContext): Promise<FlareCollectionResponse>;
 }
 
 interface ServerlessAppOptions {
@@ -40,9 +73,10 @@ interface ServerlessAppOptions {
 }
 interface ServerlessApp {
     model(name: string, definition: ModelDefinition): void;
-    execute(query: string, ctx: QueryContext): Promise<FlareResponse>;
+    collection(name: string): CollectionReference;
 }
 declare function createServerlessApp(options: ServerlessAppOptions): ServerlessApp;
+declare function extractContext(authorization: string | undefined, auth: Auth): Promise<QueryContext>;
 
 interface FunctionOptions {
     cors?: boolean;
@@ -50,4 +84,4 @@ interface FunctionOptions {
 declare function createFunction(app: ServerlessApp, auth: Auth, options?: FunctionOptions): functionsV1.HttpsFunction;
 declare function createOnRequest(app: ServerlessApp, auth: Auth, options?: FunctionOptions): firebase_functions_v2_https.HttpsFunction;
 
-export { type AuthRule, type FieldDefinition, type FlareResponse, type ModelDefinition, type QueryContext, type RelationDefinition, createFunction, createOnRequest, createServerlessApp };
+export { type CollectionReference, type DocumentReference, type FunctionOptions, type Query, type ServerlessApp, type ServerlessAppOptions, createFunction, createOnRequest, createServerlessApp, extractContext };