model User {
    fields {
        identity Identity @unique
        name Text
        email Text
        documents Document[]
    }

    actions {
        get me() {
            @where(user.identity == ctx.identity)
        }
        list listUsers()
        delete deleteUser(id)
        create createUser() with (name, email) {
            @set(user.identity = ctx.identity)
            @permission(expression: ctx.isAuthenticated)
        }
        update updateUser(id) with (name?, email?)
    }

    @permission(
        actions: [get, update, list, delete],
        expression: user.identity == ctx.identity
    )
}

model Team {
    fields {
        name Text
        description Text?
        documents Document[]
        owner Identity
        logoUrl Text?
    }

    actions {
        get getTeam(id)
        list listTeams()
        delete deleteTeam(id)
        update updateTeam(id) with (name?, description?, logoUrl?)
        write uploadTeamLogo(UploadImageInput) returns (UploadImageResponse) {
            @permission(expression: true)
        }
    }

    @unique([owner, name])

    @permission(
        actions: [get, list, update, delete],
        expression: ctx.isAuthenticated
    )
}

model TeamMembership {
    fields {
        user User
        team Team
    }

    actions {
        create createTeamMembership() with (team.name, team.description, user.id) {
            @permission(expression: ctx.isAuthenticated)
            @set(teamMembership.team.owner = ctx.identity)
        }
    }
}

model Document {
    fields {
        title Text
        content Text
        user User
        team Team?
    }

    actions {
        get getDocument(id) {
            @permission(expression: document.user.identity == ctx.identity)
        }
        list listDocuments(team.id) {
            @permission(expression: document.user.identity == ctx.identity)
        }
        delete deleteDocument(id, user.id?, team.id?) {
            @permission(expression: document.user.identity == ctx.identity)
        }
        create createDocument() with (title, content, team.id?, user.id) {
            @permission(expression: ctx.isAuthenticated)
        }
        update updateDocument(id) with (title?, content?, team.id?, user.id?)
    }

    @permission(
        actions: [get, list, update, delete],
        expression: document.user.identity == ctx.identity
    )
}

message UploadImageInput {
    base64Image Text
    teamId ID
}

message UploadImageResponse {
    path Text
}

model Invitation {
    fields {
        team Team
        email Text
        expiry Timestamp
    }

    actions {
        list activeInvites() {
            @where(invitation.expiry > ctx.now)
            @permission(expression: ctx.isAuthenticated)
        }
        create createInvite() with (email, team.id, expiry) @function
    }

    @permission(
        actions: [create, get, update],
        expression: ctx.isAuthenticated
    )
}

job PruneDatabase {
    @schedule("0 0 ? * * *")
    @permission(expression: true)
}


schema.keel

import { CreateInvite, CreateInviteHooks } from '@teamkeel/sdk';

// To learn more about what you can do with hooks,
// visit https://docs.keel.so/functions
const hooks : CreateInviteHooks = {};

export default CreateInvite(hooks);
	

<pre class="shiki " style="background-color: transparent" tabindex="0"><code>import { CreateInvite, CreateInviteHooks } from &#39;@teamkeel/sdk&#39;;

// To learn more about what you can do with hooks,
// visit https://docs.keel.so/functions
const hooks : CreateInviteHooks = {};

export default CreateInvite(hooks);
	</code></pre>

createInvite.ts

secrets:
  - name: CLOUDINARY_CLOUD_NAME
  - name: CLOUDINARY_API_KEY
  - name: CLOUDINARY_API_SECRET


<pre class="shiki " style="background-color: transparent" tabindex="0"><code>secrets:
 - name: CLOUDINARY_CLOUD_NAME
 - name: CLOUDINARY_API_KEY
 - name: CLOUDINARY_API_SECRET
</code></pre>

keelconfig.yaml

import { PruneDatabase } from '@teamkeel/sdk';

// To learn more about jobs, visit https://docs.keel.so/jobs
export default PruneDatabase(async (ctx) => {

});

<pre class="shiki " style="background-color: transparent" tabindex="0"><code>import { PruneDatabase } from &#39;@teamkeel/sdk&#39;;

// To learn more about jobs, visit https://docs.keel.so/jobs
export default PruneDatabase(async (ctx) =&gt; {

});</code></pre>

pruneDatabase.ts

import { UploadImageResponse, UploadTeamLogo } from '@teamkeel/sdk';
import { v2 as cloudinary } from 'cloudinary';

export default UploadTeamLogo(async (ctx, inputs): Promise<UploadImageResponse> => {
 cloudinary.config({
 cloud_name: ctx.secrets.CLOUDINARY_CLOUD_NAME,
 api_key: ctx.secrets.CLOUDINARY_API_KEY,
 api_secret: ctx.secrets.CLOUDINARY_API_SECRET,
 });

 try {
 const uploadResponse = await cloudinary.uploader.upload(inputs.base64Image);
 const imageUrl = uploadResponse.secure_url;

 return {
 path: imageUrl
 };
 } catch (error) {
 console.error(error);
 throw { error }
 }
})

<pre class="shiki " style="background-color: transparent" tabindex="0"><code>import { UploadImageResponse, UploadTeamLogo } from &#39;@teamkeel/sdk&#39;;
import { v2 as cloudinary } from &#39;cloudinary&#39;;

export default UploadTeamLogo(async (ctx, inputs): Promise&lt;UploadImageResponse&gt; =&gt; {
 cloudinary.config({
 cloud_name: ctx.secrets.CLOUDINARY_CLOUD_NAME,
 api_key: ctx.secrets.CLOUDINARY_API_KEY,
 api_secret: ctx.secrets.CLOUDINARY_API_SECRET,
 });

 try {
 const uploadResponse = await cloudinary.uploader.upload(inputs.base64Image);
 const imageUrl = uploadResponse.secure_url;

 return {
 path: imageUrl
 };
 } catch (error) {
 console.error(error);
 throw { error }
 }
})</code></pre>

uploadTeamLogo.ts

Notion Clone

model Todo {
    fields {
        title Text
        completed Boolean @default(false)
        owner Identity
    }

    actions {
        create createTodo() with (title) {
            @set(todo.owner = ctx.identity)
        }
        list listTodos() {
            @where(todo.owner == ctx.identity)
        }
        update updateTodo(id) with (title?, completed?)
        delete deleteTodo(id)
    }

    @permission(
        actions: [list, create, update, delete],
        expression: todo.owner == ctx.identity
    )
}


<pre class="shiki " style="background-color: transparent" tabindex="0"><code>model Todo {
 fields {
 title Text
 completed Boolean @default(false)
 owner Identity
 }

 actions {
 create createTodo() with (title) {
 @set(todo.owner = ctx.identity)
 }
 list listTodos() {
 @where(todo.owner == ctx.identity)
 }
 update updateTodo(id) with (title?, completed?)
 delete deleteTodo(id)
 }

 @permission(
 actions: [list, create, update, delete],
 expression: todo.owner == ctx.identity
 )
}
</code></pre>

auth:
  providers:
    - type: google
      name: google
      clientId: 950417749188-1i8eqpabj3gpm4fubte9cpfkrtvlv695.apps.googleusercontent.com


<pre class="shiki " style="background-color: transparent" tabindex="0"><code>auth:
 providers:
 - type: google
 name: google
 clientId: 950417749188-1i8eqpabj3gpm4fubte9cpfkrtvlv695.apps.googleusercontent.com
</code></pre>

TodoMVC (Remix)

APIs

Functions

Identity & permissions

Events

Jobs

Secrets & environment variables

Database

Testing

Frontends

Integrations

model Account {
    fields {
        identity Identity @unique
        name Text
        email Text
    }

    actions {
        get myAccount() {
            @where(ctx.identity == account.identity)
        }
    }

    @permission(
        actions: [get, create, update, delete],
        expression: ctx.identity == account.identity
    )
}


<pre class="shiki " style="background-color: transparent" tabindex="0"><code>model Account {
 fields {
 identity Identity @unique
 name Text
 email Text
 }

 actions {
 get myAccount() {
 @where(ctx.identity == account.identity)
 }
 }

 @permission(
 actions: [get, create, update, delete],
 expression: ctx.identity == account.identity
 )
}
</code></pre>

Fetching the account of the currently signed in users

model MyModel {
    actions {
        write myAction() returns (MyActionResponse)
    }
}

message MyActionResponse {
    hello Text
}


<pre class="shiki " style="background-color: transparent" tabindex="0"><code>model MyModel {
 actions {
 write myAction() returns (MyActionResponse)
 }
}

message MyActionResponse {
 hello Text
}
</code></pre>

import { beforeEach, expect, test, afterEach } from "vitest";
import { actions } from "@teamkeel/testing";
import { createServer, Server } from "node:http";

let server: Server;

beforeEach(() => {
  server = createServer((req, res) => {
    res.statusCode = 200;
    res.setHeader("Content-Type", "application/json");
    res.write(
      JSON.stringify({
        hello: "world",
      })
    );
    res.end();
  });
  server.listen(8123);
});

afterEach(() => {
  server.close();
});

test("myAction", async () => {
  const res = await actions.myAction();
  expect(res.hello).toBe("world");
});


<pre class="shiki " style="background-color: transparent" tabindex="0"><code>import { beforeEach, expect, test, afterEach } from &quot;vitest&quot;;
import { actions } from &quot;@teamkeel/testing&quot;;
import { createServer, Server } from &quot;node:http&quot;;

let server: Server;

beforeEach(() =&gt; {
 server = createServer((req, res) =&gt; {
 res.statusCode = 200;
 res.setHeader(&quot;Content-Type&quot;, &quot;application/json&quot;);
 res.write(
 JSON.stringify({
 hello: &quot;world&quot;,
 })
 );
 res.end();
 });
 server.listen(8123);
});

afterEach(() =&gt; {
 server.close();
});

test(&quot;myAction&quot;, async () =&gt; {
 const res = await actions.myAction();
 expect(res.hello).toBe(&quot;world&quot;);
});
</code></pre>

myAction.test.ts

import { MyAction, permissions } from "@teamkeel/sdk";

export default MyAction(async (ctx, inputs) => {
  permissions.allow();

  const res = await fetch(ctx.env.MY_API_URL);
  const body = await res.json();
  return body;
});


<pre class="shiki " style="background-color: transparent" tabindex="0"><code>import { MyAction, permissions } from &quot;@teamkeel/sdk&quot;;

export default MyAction(async (ctx, inputs) =&gt; {
 permissions.allow();

 const res = await fetch(ctx.env.MY_API_URL);
 const body = await res.json();
 return body;
});
</code></pre>

Let's get building

Example apps

Guides

Features

Patterns