Modèles TypeScript pour Appwrite

VérifiéSûr

Définit des interfaces TypeScript standard pour les collections Appwrite. Utilisez-le pour créer des modèles pour Tours, Utilisateurs ou Réservations, garantissant une sécurité de type complète avec champs Appwrite et énumérations.

Spar Skills Guide Bot
DeveloppementDébutant
03/03/2026
Claude CodeCursorWindsurfCopilotCodex
#typescript#appwrite#type-safety#interfaces#data-modeling

Recommandé pour

Synthèse automatique

Génère des interfaces TypeScript typées pour les collections Appwrite, en étendant Models.Document et en centralisant les modèles dans un dossier types/.

Points forts

  • Inclut systématiquement les champs Appwrite standards ($id, $createdAt, $updatedAt, $permissions)
  • Propose des union types pour les champs à valeurs fixes comme BookingStatus
  • Montre l'usage des génériques avec le SDK Appwrite (databases.listDocuments<Tour>)
  • Rappelle l'option readonly pour les champs non mutables côté frontend

Limites

  • Très spécifique à Appwrite et à un domaine d'exemple (Tours, Bookings) qui doit être adapté
  • Ne couvre ni la validation à l'exécution ni la génération automatique depuis le schéma Appwrite
  • Les permissions et relations complexes ne sont pas détaillées
Quand l'utiliser

À utiliser dès qu'on crée ou typait une collection Appwrite pour éviter any et garder des modèles cohérents.

Quand l'éviter

Inutile si le projet n'utilise pas Appwrite ou dispose déjà d'une génération de types automatisée depuis le schéma.

Analyse de sécurité

Sûr
Score qualité85/100

The skill only provides TypeScript interface definitions and guidance for modeling Appwrite collections. It declares no tools and contains no executable commands, network calls, credential handling, or destructive actions.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

New collection model
Create a TypeScript interface for a new Appwrite 'Review' collection with rating, comment, userId and tourId, extending Models.Document and putting it in types/.
Typed SDK query
Show me how to fetch tours with full type safety using databases.listDocuments with my Tour interface.
Fixed-value status field
Add a status field with fixed values to my Booking interface using a TypeScript union type instead of a plain string.

name: defining-typescript-models description: Defines standard TypeScript interfaces for Appwrite Collections. Use when creating new models for Tours, Users, or Bookings to ensure full type safety.

TypeScript Models and Interfaces

When to use this skill

  • When defining the data structure for a new Appwrite collection.
  • When creating props for components that data-fetch.
  • To avoid using any across the codebase.

Workflow

  • [ ] Export interfaces from a central types/ directory.
  • [ ] Include standard Appwrite fields ($id, $createdAt, $updatedAt, $permissions).
  • [ ] Use Enums for fields with fixed values (e.g., BookingStatus).

Example Template

import { Models } from 'appwrite';

export interface Tour extends Models.Document {
    title: string;
    description: string;
    price: number;
    location: string;
    images: string[];
    rating: number;
    availableDates: string[]; // ISO Strings
}

export type BookingStatus = 'pending' | 'confirmed' | 'cancelled';

export interface Booking extends Models.Document {
    userId: string;
    tourId: string;
    status: BookingStatus;
    totalPrice: number;
}

Instructions

  • Generics: Use these interfaces with Appwrite SDK methods: databases.listDocuments<Tour>(...).
  • Readonly: Mark fields as readonly if they shouldn't be mutated by the frontend.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/typescript-models-for-appwrite-mma3jsf5' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/typescript-models-for-appwrite-mma3jsf5/download' --output '.skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md.part' && mv '.skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md.part' '.skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md' && test -s '.skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/defining-typescript-models' && cp -R '.skill-downloads/typescript-models-for-appwrite-mma3jsf5' '.claude/skills/defining-typescript-models'

Cursor
test -f '.skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md' && test -s '.skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/defining-typescript-models' && cp -R '.skill-downloads/typescript-models-for-appwrite-mma3jsf5' '.cursor/skills/defining-typescript-models'

Codex
test -f '.skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md' && test -s '.skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/defining-typescript-models' && cp -R '.skill-downloads/typescript-models-for-appwrite-mma3jsf5' '.agents/skills/defining-typescript-models'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/typescript-models-for-appwrite-mma3jsf5'

openskills read 'typescript-models-for-appwrite-mma3jsf5'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/typescript-models-for-appwrite-mma3jsf5/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires