Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 130 additions & 0 deletions node/generate-with-modal-labs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
6 changes: 6 additions & 0 deletions node/generate-with-modal-labs/.prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"trailingComma": "es5",
"tabWidth": 2,
"semi": true,
"singleQuote": true
}
75 changes: 75 additions & 0 deletions node/generate-with-modal-labs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# 🤖 Node.js Generate with FAL Function

Generate images using FAL's API.

## 🧰 Usage

### GET /

HTML form for interacting with the function.

### POST /

Query the model for a completion.

**Parameters**

| Name | Description | Location | Type | Sample Value |
| ------------ | ------------------------------------ | -------- | ------------------ | ----------------------------------------------- |
| Content-Type | The content type of the request body | Header | `application/json` | N/A |
| prompt | Text to prompt the model | Body | String | `city nightscape neon cyberpunk photorealistic` |

Sample `200` Response:

Response when the model successfully responds.

```json
{
"ok": true,
"src": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
```

Sample `400` Response:

Response when the request body is missing.

```json
{
"ok": false,
"error": "Missing body with a prompt."
}
```

Sample `500` Response:

Response when the model fails to respond.

```json
{
"ok": false,
"error": "Failed to query model."
}
```

## ⚙️ Configuration

| Setting | Value |
| ----------------- | ------------- |
| Runtime | Node (18.0) |
| Entrypoint | `src/main.js` |
| Build Commands | `npm install` |
| Permissions | `any` |
| Timeout (Seconds) | 900 |

## 🔒 Environment Variables

### MODAL_TOKEN

A unique key used to authenticate with the Modal API. This key is used to query the model for completions. You can obtain this key by signing up for an account at [Modal](https://modal.com/).

| Question | Answer |
| ------------- | --------------------------------------------- |
| Required | Yes |
| Sample Value | `$MODAL_TOKEN_ID:$MODAL_TOKEN_SECRET` |
| Documentation | https://modal.com/docs/reference/modal.config |
9 changes: 9 additions & 0 deletions node/generate-with-modal-labs/env.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
declare global {
namespace NodeJS {
interface ProcessEnv {
MODAL_TOKEN: string;
}
}
}

export {};
30 changes: 30 additions & 0 deletions node/generate-with-modal-labs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions node/generate-with-modal-labs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "generate-with-modal-labs",
"version": "1.0.0",
"description": "",
"main": "src/main.js",
"type": "module",
"scripts": {
"format": "prettier --write ."
},
"keywords": [],
"devDependencies": {
"prettier": "^3.2.5"
}
}
54 changes: 54 additions & 0 deletions node/generate-with-modal-labs/src/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
import { getStaticFile, throwIfMissing } from './utils.js';

export default async ({ req, res, error }) => {
throwIfMissing(process.env, ['MODAL_TOKEN']);

if (req.method === 'GET') {
return res.send(getStaticFile('index.html'), 200, {
'Content-Type': 'text/html; charset=utf-8',
});
}

if (!req.body.prompt || typeof req.body.prompt !== 'string') {
return res.json(
{ ok: false, error: 'Missing required field `prompt`' },
400
);
}

const body = JSON.stringify({
prompt: req.body.prompt,
height: 768,
width: 768,
num_outputs: 1,
});

const response = await fetch(
'https://modal-labs--instant-stable-diffusion-xl.modal.run/v1/inference',
{
method: 'POST',
headers: {
Authorization: `Token ${process.env.MODAL_TOKEN}`,
'Content-Type': 'application/json',
},
body,
}
);

if (response.status !== 201) {
const message = await response.text();
return res.json(
{ ok: false, error: `Failed to generate image: ${message}` },
500
);
}

const arrayBuffer = await response.arrayBuffer();
const buffer = Buffer.from(arrayBuffer);
const base64 = buffer.toString('base64');

return res.json({
ok: true,
src: `data:image/png;base64,${base64}`,
});
};
34 changes: 34 additions & 0 deletions node/generate-with-modal-labs/src/utils.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import path from 'path';
import { fileURLToPath } from 'url';
import fs from 'fs';

/**
* Throws an error if any of the keys are missing from the object
* @param {*} obj
* @param {string[]} keys
* @throws {Error}
*/
export function throwIfMissing(obj, keys) {
const missing = [];
for (let key of keys) {
if (!(key in obj) || !obj[key]) {
missing.push(key);
}
}
if (missing.length > 0) {
throw new Error(`Missing required fields: ${missing.join(', ')}`);
}
}

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const staticFolder = path.join(__dirname, '../static');

/**
* Returns the contents of a file in the static folder
* @param {string} fileName
* @returns {string} Contents of static/{fileName}
*/
export function getStaticFile(fileName) {
return fs.readFileSync(path.join(staticFolder, fileName)).toString();
}
Loading