@teamflojo/floimg-screenshot 0.1.0 → 0.2.0

package/README.md

@@ -1,11 +1,11 @@
-# imgflo-screenshot
+# floimg-screenshot
 
-Screenshot generator for imgflo using Playwright headless browser.
+Screenshot generator for floimg using Playwright headless browser.
 
 ## Installation
 
 ```bash
-npm install imgflo imgflo-screenshot
+npm install @teamflojo/floimg @teamflojo/floimg-screenshot
 ```
 
 This will automatically install Playwright and download Chromium (~200MB).
@@ -13,10 +13,10 @@ This will automatically install Playwright and download Chromium (~200MB).
 ## Usage
 
 ```typescript
-import createClient from 'imgflo';
-import screenshot from 'imgflo-screenshot';
+import createClient from '@teamflojo/floimg';
+import screenshot from '@teamflojo/floimg-screenshot';
 
-const imgflo = createClient({
+const floimg = createClient({
   store: {
     default: 's3',
     s3: { region: 'us-east-1', bucket: 'my-screenshots' }
@@ -24,10 +24,10 @@ const imgflo = createClient({
 });
 
 // Register the screenshot generator
-imgflo.registerGenerator(screenshot());
+floimg.registerGenerator(screenshot());
 
 // Screenshot a website
-const site = await imgflo.generate({
+const site = await floimg.generate({
   generator: 'screenshot',
   params: {
     url: 'https://example.com',
@@ -37,7 +37,7 @@ const site = await imgflo.generate({
 });
 
 // Upload to S3
-const result = await imgflo.save(site, './output/example.png');
+const result = await floimg.save(site, './output/example.png');
 console.log(result.url);
 ```
 
@@ -46,10 +46,10 @@ console.log(result.url);
 ### 1. Website Screenshots
 
 ```typescript
-await imgflo.generate({
+await floimg.generate({
   generator: 'screenshot',
   params: {
-    url: 'https://github.com/bcooke/imgflo',
+    url: 'https://github.com/bcooke/floimg',
     width: 1280,
     height: 800,
     fullPage: true  // Capture entire page
@@ -62,7 +62,7 @@ await imgflo.generate({
 Perfect for generating images from HTML/CSS:
 
 ```typescript
-await imgflo.generate({
+await floimg.generate({
   generator: 'screenshot',
   params: {
     html: `
@@ -82,7 +82,7 @@ await imgflo.generate({
 Capture specific elements:
 
 ```typescript
-await imgflo.generate({
+await floimg.generate({
   generator: 'screenshot',
   params: {
     url: 'https://example.com',
@@ -98,7 +98,7 @@ await imgflo.generate({
 Wait for dynamic content to load:
 
 ```typescript
-await imgflo.generate({
+await floimg.generate({
   generator: 'screenshot',
   params: {
     url: 'https://example.com/dashboard',
@@ -111,7 +111,7 @@ await imgflo.generate({
 ### 5. High DPI / Retina Screenshots
 
 ```typescript
-await imgflo.generate({
+await floimg.generate({
   generator: 'screenshot',
   params: {
     url: 'https://example.com',
@@ -127,7 +127,7 @@ await imgflo.generate({
 ### Generator Options
 
 ```typescript
-imgflo.registerGenerator(screenshot({
+floimg.registerGenerator(screenshot({
   persistent: true,        // Reuse browser instance (faster)
   defaultWidth: 1920,
   defaultHeight: 1080,
@@ -144,12 +144,12 @@ For better performance when taking multiple screenshots:
 
 ```typescript
 const screenshotGen = screenshot({ persistent: true });
-imgflo.registerGenerator(screenshotGen);
+floimg.registerGenerator(screenshotGen);
 
 // Take multiple screenshots - browser stays open
-await imgflo.generate({ generator: 'screenshot', params: { url: 'https://site1.com' } });
-await imgflo.generate({ generator: 'screenshot', params: { url: 'https://site2.com' } });
-await imgflo.generate({ generator: 'screenshot', params: { url: 'https://site3.com' } });
+await floimg.generate({ generator: 'screenshot', params: { url: 'https://site1.com' } });
+await floimg.generate({ generator: 'screenshot', params: { url: 'https://site2.com' } });
+await floimg.generate({ generator: 'screenshot', params: { url: 'https://site3.com' } });
 
 // Browser closes when process exits
 ```
@@ -177,7 +177,7 @@ await imgflo.generate({ generator: 'screenshot', params: { url: 'https://site3.c
 Generate OG images from HTML:
 
 ```typescript
-const ogImage = await imgflo.generate({
+const ogImage = await floimg.generate({
   generator: 'screenshot',
   params: {
     html: `
@@ -219,7 +219,7 @@ const ogImage = await imgflo.generate({
 Capture a live dashboard:
 
 ```typescript
-const dashboard = await imgflo.generate({
+const dashboard = await floimg.generate({
   generator: 'screenshot',
   params: {
     url: 'https://internal-dashboard.company.com',
@@ -234,7 +234,7 @@ const dashboard = await imgflo.generate({
 ### Mobile Viewport
 
 ```typescript
-const mobile = await imgflo.generate({
+const mobile = await floimg.generate({
   generator: 'screenshot',
   params: {
     url: 'https://example.com',
@@ -275,7 +275,7 @@ npx playwright install-deps chromium
 Increase timeout for slow-loading pages:
 
 ```typescript
-await imgflo.generate({
+await floimg.generate({
   generator: 'screenshot',
   params: {
     url: 'https://slow-site.com',
@@ -289,7 +289,7 @@ await imgflo.generate({
 Ensure selector exists:
 
 ```typescript
-await imgflo.generate({
+await floimg.generate({
   generator: 'screenshot',
   params: {
     url: 'https://example.com',
@@ -312,5 +312,5 @@ MIT
 
 ## See Also
 
-- [imgflo](https://github.com/bcooke/imgflo) - Core library
+- [floimg](https://github.com/bcooke/floimg) - Core library
 - [Playwright](https://playwright.dev) - Browser automation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamflojo/floimg-screenshot",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Screenshot generator for floimg using Playwright headless browser",
   "type": "module",
   "main": "./dist/index.js",
@@ -16,6 +16,15 @@
     "README.md",
     "LICENSE"
   ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "postinstall": "playwright install chromium",
+    "prepublishOnly": "npm run build"
+  },
   "keywords": [
     "floimg",
     "screenshot",
@@ -39,19 +48,11 @@
   },
   "devDependencies": {
     "@types/node": "^22.10.2",
+    "@teamflojo/floimg": "workspace:*",
     "typescript": "^5.7.2",
-    "vitest": "^2.1.8",
-    "@teamflojo/floimg": "0.1.0"
+    "vitest": "^2.1.8"
   },
   "engines": {
     "node": ">=18.0.0"
-  },
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "test": "vitest",
-    "typecheck": "tsc --noEmit",
-    "clean": "rm -rf dist",
-    "postinstall": "playwright install chromium"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Brett Cooke
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.